wcs.api

Interface Env

All Superinterfaces:

Content

All Known Implementing Classes:

Env, TestEnv

public interface Env
extends Content

Method Summary

Methods

Modifier and Type	Method and Description
void	addDependency() Add a dependency on anything
void	addDependency(Id id) Add an EXACT dependency on a given asset
void	addDependency(Id id, AssetDeps deps) Add a dependency of the specified type on a given asset
void	addDependency(java.lang.String c) Add a dependency on any asset of the given type
void	addDependency(java.lang.String c, java.lang.Long cid) Add an EXACT dependency on a given asset
void	addDependency(java.lang.String c, java.lang.Long cid, AssetDeps deps) Add a dependency of the specified type on a given asset
java.lang.String	call(java.lang.String name, Arg... args) Call a CS Element in current site
void	clearError() Clear the current error code
boolean	exists(java.lang.String attribute) Check if the given attribute is a valid value
boolean	exists(java.lang.String attribute, int pos) Check if the given attribute at the given position is a valid value
java.util.List<Id>	find(java.lang.String type, Arg... args) Find assets
Asset	findOne(java.lang.String type, Arg... args) Find one assets
Asset	getAsset() Return the asset identified by the current c/cid
Asset	getAsset(Id id) Return the asset identified by and Id (or null if not found)
Asset	getAsset(java.lang.String c, java.lang.Long cid) Return the asset identified by c/cid (or null if not possible)
java.lang.String	getC() Return current "c" (content type)
java.lang.Long	getCid() Return current "cid" (content id)
Config	getConfig() Return the current config
java.util.Date	getDate(java.lang.String var) Get variable as a date (or null)
java.util.Date	getDate(java.lang.String ls, int pos) Get the field value at given position as a date, or null
java.util.Date	getDate(java.lang.String ls, int pos, java.lang.String field) Get field at given position as a date, or null
java.util.Date	getDate(java.lang.String ls, java.lang.String field) Get field as date or null
int	getError() Get Error nummber
Id	getId() Return current asset id
java.lang.Integer	getInt(java.lang.String var) Get variable as Long or null
java.lang.Integer	getInt(java.lang.String ls, int pos) Get the field "value" at given position as an int, or null
java.lang.Integer	getInt(java.lang.String ls, int pos, java.lang.String field) Get field at given position as an int, or null
java.lang.Integer	getInt(java.lang.String ls, java.lang.String field) Get field as long or null
java.lang.Long	getLong(java.lang.String var) Get variable as Long or null
java.lang.Long	getLong(java.lang.String ls, int pos) Get field "value" at given position as a long, or null
java.lang.Long	getLong(java.lang.String ls, int pos, java.lang.String field) Get field at given position as a long, or null
java.lang.Long	getLong(java.lang.String ls, java.lang.String field) Get field as long or null
java.lang.Object	getObject(java.lang.String object) Get an object
java.lang.Iterable<java.lang.Integer>	getRange(java.lang.String list) Return an iterable sequence of integers to loop a list
Router	getRouter() Return the current router
java.lang.String	getSiteId() The current site id
java.lang.String	getSiteName() The current site name
SitePlan	getSitePlan()
Id	getSitePlanRoot(java.lang.String siteName) Return the siteplan root of the given site
int	getSize(java.lang.String list) Return size of a list
java.lang.String	getString(java.lang.String var) Get a variable or null
java.lang.String	getString(java.lang.String list, int row) Get the field "value" of a list or null
java.lang.String	getString(java.lang.String list, int row, java.lang.String field) Get the nth field of a list or null
java.lang.String	getString(java.lang.String list, java.lang.String field) Get the field of a list or null
java.lang.String	getUrl(Id id, Arg... args) Return the URL to render this asset - note that rendering is different if we are in insite/preview mode or in live mode
java.lang.String	getUrl(java.lang.String c, java.lang.Long cid, Arg... args) Return the URL to render this asset
ICS	ics() Return the underlying ICS
void	init(ICS ics) Initialize the class with the ICS
boolean	isError() Check if in error state
boolean	isInsite() Check if we are in the insite editing mode
boolean	isList(java.lang.String list) Check if it is a list
boolean	isList(java.lang.String list, int n) Check if it is a list with enough rows
boolean	isListCol(java.lang.String list, java.lang.String field) Check if exists as a list column
boolean	isObj(java.lang.String object) Check if exists as an object
boolean	isVar(java.lang.String variable) Check if is a variable

Methods inherited from interface wcs.api.Content

dump, dump

Method Detail

init

void init(ICS ics)

Initialize the class with the ICS

ics

ICS ics()

Return the underlying ICS

getSitePlanRoot

Id getSitePlanRoot(java.lang.String siteName)

Return the siteplan root of the given site

getString

java.lang.String getString(java.lang.String var)

Get a variable or null

Specified by:

getString in interface Content

Parameters:

var -

Returns:

getString

java.lang.String getString(java.lang.String list,
                         java.lang.String field)

Get the field of a list or null

Parameters:

list -

field -

Returns:

getString

java.lang.String getString(java.lang.String list,
                         int row,
                         java.lang.String field)

Get the nth field of a list or null

Parameters:

list -

row -

field -

Returns:

getString

java.lang.String getString(java.lang.String list,
                         int row)

Get the field "value" of a list or null

Specified by:

getString in interface Content

Parameters:

list -

row -

field -

Returns:

getSize

int getSize(java.lang.String list)

Return size of a list

Specified by:

getSize in interface Content

Parameters:

list -

Returns:

getRange

java.lang.Iterable<java.lang.Integer> getRange(java.lang.String list)

Return an iterable sequence of integers to loop a list

Specified by:

getRange in interface Content

Parameters:

list -

Returns:

getDate

java.util.Date getDate(java.lang.String var)

Get variable as a date (or null)

Specified by:

getDate in interface Content

Parameters:

var -

Returns:

getInt

java.lang.Integer getInt(java.lang.String var)

Get variable as Long or null

Specified by:

getInt in interface Content

Parameters:

var -

Returns:

getLong

java.lang.Long getLong(java.lang.String var)

Get variable as Long or null

Specified by:

getLong in interface Content

Parameters:

var -

Returns:

getDate

java.util.Date getDate(java.lang.String ls,
                     java.lang.String field)

Get field as date or null

Parameters:

ls -

field -

Returns:

getInt

java.lang.Integer getInt(java.lang.String ls,
                       java.lang.String field)

Get field as long or null

Parameters:

ls -

field -

Returns:

getLong

java.lang.Long getLong(java.lang.String ls,
                     java.lang.String field)

Get field as long or null

Parameters:

ls -

field -

Returns:

getDate

java.util.Date getDate(java.lang.String ls,
                     int pos,
                     java.lang.String field)

Get field at given position as a date, or null

Parameters:

ls -

field -

pos -

Returns:

getDate

java.util.Date getDate(java.lang.String ls,
                     int pos)

Get the field value at given position as a date, or null

Specified by:

getDate in interface Content

Parameters:

ls -

field -

pos -

Returns:

getLong

java.lang.Long getLong(java.lang.String ls,
                     int pos,
                     java.lang.String field)

Get field at given position as a long, or null

Parameters:

ls -

field -

pos -

Returns:

getLong

java.lang.Long getLong(java.lang.String ls,
                     int pos)

Get field "value" at given position as a long, or null

Specified by:

getLong in interface Content

Parameters:

ls -

field -

pos -

Returns:

getInt

java.lang.Integer getInt(java.lang.String ls,
                       int pos,
                       java.lang.String field)

Get field at given position as an int, or null

Parameters:

ls -

field -

pos -

Returns:

getInt

java.lang.Integer getInt(java.lang.String ls,
                       int pos)

Get the field "value" at given position as an int, or null

Specified by:

getInt in interface Content

Parameters:

ls -

field -

pos -

Returns:

getError

int getError()

Get Error nummber

isError

boolean isError()

Check if in error state

isVar

boolean isVar(java.lang.String variable)

Check if is a variable

isList

boolean isList(java.lang.String list)

Check if it is a list

isList

boolean isList(java.lang.String list,
             int n)

Check if it is a list with enough rows

isListCol

boolean isListCol(java.lang.String list,
                java.lang.String field)

Check if exists as a list column

isObj

boolean isObj(java.lang.String object)

Check if exists as an object

isInsite

boolean isInsite()

Check if we are in the insite editing mode

getObject

java.lang.Object getObject(java.lang.String object)

Get an object

getAsset

Asset getAsset(java.lang.String c,
             java.lang.Long cid)

Return the asset identified by c/cid (or null if not possible)

getAsset

Asset getAsset(Id id)

Return the asset identified by and Id (or null if not found)

getAsset

Asset getAsset()

Return the asset identified by the current c/cid

getC

java.lang.String getC()

Return current "c" (content type)

Returns:

getCid

java.lang.Long getCid()

Return current "cid" (content id)

getId

Id getId()

Return current asset id

getConfig

Config getConfig()

Return the current config

getRouter

Router getRouter()

Return the current router

getSiteName

java.lang.String getSiteName()

The current site name

getSiteId

java.lang.String getSiteId()

The current site id

getSitePlan

SitePlan getSitePlan()

getUrl

java.lang.String getUrl(Id id,
                      Arg... args)

Return the URL to render this asset - note that rendering is different if we are in insite/preview mode or in live mode

getUrl

java.lang.String getUrl(java.lang.String c,
                      java.lang.Long cid,
                      Arg... args)

Return the URL to render this asset

find

java.util.List<Id> find(java.lang.String type,
                      Arg... args)

Find assets

findOne

Asset findOne(java.lang.String type,
            Arg... args)

Find one assets

call

java.lang.String call(java.lang.String name,
                    Arg... args)

Call a CS Element in current site

Parameters:

name -

args -

Returns:

clearError

void clearError()

Clear the current error code

addDependency

void addDependency()

Add a dependency on anything

addDependency

void addDependency(java.lang.String c)

Add a dependency on any asset of the given type

Parameters:

c -

addDependency

void addDependency(java.lang.String c,
                 java.lang.Long cid)

Add an EXACT dependency on a given asset

Parameters:

c -

cid -

addDependency

void addDependency(java.lang.String c,
                 java.lang.Long cid,
                 AssetDeps deps)

Add a dependency of the specified type on a given asset

Parameters:

c -

cid -

addDependency

void addDependency(Id id)

Add an EXACT dependency on a given asset

Parameters:

id -

addDependency

void addDependency(Id id,
                 AssetDeps deps)

Add a dependency of the specified type on a given asset

Parameters:

id -

deps -

exists

boolean exists(java.lang.String attribute)

Check if the given attribute is a valid value

Specified by:

exists in interface Content

Parameters:

attribute -

Returns:

exists

boolean exists(java.lang.String attribute,
             int pos)

Check if the given attribute at the given position is a valid value

Specified by:

exists in interface Content

Parameters:

attribute -

Returns: