wcs.api

Interface Asset

All Superinterfaces:

Content

All Known Implementing Classes:

Asset

public interface Asset
extends Content

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	call(java.lang.String name, Arg... args) Invoke the template using the current asset as current asset, optionally passing a set of parameters
java.lang.String	editString(java.lang.String attribute) Render the attribute as an editable string in insite mode.
java.lang.String	editString(java.lang.String attribute, int n) Render the nth attribute as an editable string in insite mode.
java.lang.String	editString(java.lang.String attribute, int n, java.lang.String params, Arg... args) Edit the n-th element of the given attribute, using the given parameters.
java.lang.String	editString(java.lang.String attribute, java.lang.String params, Arg... args) Edit (or return if not insite) the first named attribute as a string, or null if not found and pass additional parameters
java.lang.String	editText(java.lang.String attribute, int n, java.lang.String params) Edit (or return if not insite) the nth named attribute as a string, or null if not found and pass additional parameters using the CK editor
java.lang.String	editText(java.lang.String attribute, java.lang.String params) Edit (or return if not insite) the first named attribute as a string, or null if not found using the CK editor
boolean	exists(java.lang.String attribute) Does the attribute exist?
boolean	exists(java.lang.String attribute, int pos) Does the nth attribute exist?
Asset	getAsset(java.lang.String attribute, int i, java.lang.String type, AssetDeps logdep) Return the related asset pointed by the nth attribute of the given type.
Asset	getAsset(java.lang.String attribute, java.lang.String type) Return the related asset pointed by the attribute of the given type.
Asset	getAsset(java.lang.String attribute, java.lang.String type, AssetDeps logdep) Return the related asset pointed by the attribute of the given type.
Asset	getAsset(java.lang.String attribute, java.lang.String type, int i) Return the related asset pointed by the nth attribute of the given type.
java.lang.Long	getAssocId(java.lang.String assoc) Id of the first associated asset
java.lang.Long	getAssocId(java.lang.String assoc, int pos) Id of the nth associated asset
java.lang.Iterable<java.lang.Integer>	getAssocRange(java.lang.String assoc) Range of an asset association
java.lang.String	getAssocType(java.lang.String assoc) Type of the first associated asset
java.lang.String	getAssocType(java.lang.String assoc, int pos) Type of the nth associated asset
java.lang.String	getBlobUrl(java.lang.String attribute, Arg... args) String get blob url of the first attribute, with optional args
java.lang.String	getBlobUrl(java.lang.String attribute, int pos, java.lang.String mimeType, Arg... args) String get blob url of the nth attribute, with optional args
java.lang.String	getBlobUrl(java.lang.String attribute, java.lang.String mimeType, Arg... args) String get blob url of the first attribute, with optional args
java.lang.String	getC() The current asset type
java.lang.Long	getCid() The current id, or null if undefined
java.lang.Long	getCid(java.lang.String attribute) Return the first attribute of the attribute list as an id (long), or null if not found
java.lang.Long	getCid(java.lang.String attribute, int n) Return the nth attribute of the named attribute as an id (long), or null if not found
java.util.Date	getDate(java.lang.String attribute) Return the first attribute of the the attribute list as an int, or null if not found
java.util.Date	getDate(java.lang.String attribute, int n) Return the nth attribute of the the attribute list as an int, or null if not found
java.lang.String	getDescription() The current asset description, or the name if the description is undefined
java.util.Date	getEndDate() Current asset end date or null if undefined
java.util.Date	getFieldDate(java.lang.String name) Return a named field from the asset as a date.
int	getFieldInt(java.lang.String name) Return a named field from the asset as an int.
long	getFieldLong(java.lang.String name) Return a named field from the asset as a long.
java.lang.String	getFieldString(java.lang.String name) Return a named field from the asset as a string.
java.lang.String	getFilename() Current asset file
Id	getId() The current asset id
java.lang.Integer	getInt(java.lang.String attribute) Return the first attribute of the the attribute list as an int, or null if not found
java.lang.Integer	getInt(java.lang.String attribute, int n) Return the nth attribute of the the attribute list as an int, or null if not found
java.lang.Long	getLong(java.lang.String attribute) Return the first attribute of the the attribute list as a long, or null if not found
java.lang.Long	getLong(java.lang.String attribute, int n) Return the nth attribute of the the attribute list as an int, or null if not found
java.lang.String	getName() The current asset name
java.lang.String	getPath() Current asset path
java.lang.Iterable<java.lang.Integer>	getRange(java.lang.String attribute) Return an iterable of the attribute list
java.lang.String	getSite() Return the current site name
int	getSize(java.lang.String attribute) Return the number of elements in the attribute
java.util.Date	getStartDate() Current asset start date or null if undefined
java.lang.String	getString(java.lang.String attribute) Return the first attribute of the the named attribute as a string, or null if not found
java.lang.String	getString(java.lang.String attribute, int n) Return the nth named attribute as a string, or null if not found
java.lang.String	getSubtype() The current asset subtype, or the void string if no subtype
java.lang.String	getTemplate() The current template or null if undefined
java.lang.String	getUrl(Arg... args) Return the URL to render this asset
java.lang.String	slot(java.lang.String attribute, int i, java.lang.String type, java.lang.String template, java.lang.String emptyText, Arg... args) Render a single slot pointed by the i-th asset field using the the specified template.
java.lang.String	slot(java.lang.String attribute, java.lang.String type, java.lang.String template, java.lang.String emptyText, Arg... args) Render a single slot pointed by the first asset field using the the specified template.
java.lang.String	slotEmpty(java.lang.String attribute, java.lang.String type, java.lang.String template, java.lang.String emptyText) Render an empty slot.
java.lang.String	slotList(java.lang.String field, java.lang.String type, java.lang.String template, Arg... args) Render a list of slots pointed by the asset field using the the specified template.

Methods inherited from interface wcs.api.Content

dump, dump

Method Detail

getSite

java.lang.String getSite()

Return the current site name

Returns:

getId

Id getId()

The current asset id

Returns:

getC

java.lang.String getC()

The current asset type

Returns:

getCid

java.lang.Long getCid()

The current id, or null if undefined

Returns:

getTemplate

java.lang.String getTemplate()

The current template or null if undefined

Returns:

getAssocRange

java.lang.Iterable<java.lang.Integer> getAssocRange(java.lang.String assoc)

Range of an asset association

getAssocId

java.lang.Long getAssocId(java.lang.String assoc)

Id of the first associated asset

getAssocId

java.lang.Long getAssocId(java.lang.String assoc,
                        int pos)

Id of the nth associated asset

getAssocType

java.lang.String getAssocType(java.lang.String assoc)

Type of the first associated asset

getAssocType

java.lang.String getAssocType(java.lang.String assoc,
                            int pos)

Type of the nth associated asset

getSubtype

java.lang.String getSubtype()

The current asset subtype, or the void string if no subtype

Returns:

getName

java.lang.String getName()

The current asset name

Returns:

getDescription

java.lang.String getDescription()

The current asset description, or the name if the description is undefined

Returns:

getFilename

java.lang.String getFilename()

Current asset file

Returns:

getPath

java.lang.String getPath()

Current asset path

Returns:

getStartDate

java.util.Date getStartDate()

Current asset start date or null if undefined

Returns:

getEndDate

java.util.Date getEndDate()

Current asset end date or null if undefined

Returns:

getSize

int getSize(java.lang.String attribute)

Return the number of elements in the attribute

Specified by:

getSize in interface Content

Parameters:

attribute -

Returns:

getCid

java.lang.Long getCid(java.lang.String attribute)

Return the first attribute of the attribute list as an id (long), or null if not found

Parameters:

asset -

Returns:

getFieldString

java.lang.String getFieldString(java.lang.String name)

Return a named field from the asset as a string.

Parameters:

name -

Returns:

getFieldDate

java.util.Date getFieldDate(java.lang.String name)

Return a named field from the asset as a date.

Parameters:

name -

Returns:

getFieldInt

int getFieldInt(java.lang.String name)

Return a named field from the asset as an int.

Parameters:

name -

Returns:

getFieldLong

long getFieldLong(java.lang.String name)

Return a named field from the asset as a long.

Parameters:

name -

Returns:

getAsset

Asset getAsset(java.lang.String attribute,
             java.lang.String type,
             AssetDeps logdep)

Return the related asset pointed by the attribute of the given type. Specify the dependency type you are going to use when accessing this asset.

Parameters:

asset -

Returns:

getAsset

Asset getAsset(java.lang.String attribute,
             java.lang.String type)

Return the related asset pointed by the attribute of the given type. It does not log any dependencies - use only if you use to generate urls or retrieve other assets.

getAsset

Asset getAsset(java.lang.String attribute,
             java.lang.String type,
             int i)

Return the related asset pointed by the nth attribute of the given type. It does not log any dependencies - use only if you use to generate urls or retrieve other assets.

getAsset

Asset getAsset(java.lang.String attribute,
             int i,
             java.lang.String type,
             AssetDeps logdep)

Return the related asset pointed by the nth attribute of the given type. Since you are accessing another asset it is mandatory to specify the dependency type you are going to use.

Parameters:

asset -

Returns:

getBlobUrl

java.lang.String getBlobUrl(java.lang.String attribute,
                          Arg... args)

String get blob url of the first attribute, with optional args

getBlobUrl

java.lang.String getBlobUrl(java.lang.String attribute,
                          java.lang.String mimeType,
                          Arg... args)

String get blob url of the first attribute, with optional args

getBlobUrl

java.lang.String getBlobUrl(java.lang.String attribute,
                          int pos,
                          java.lang.String mimeType,
                          Arg... args)

String get blob url of the nth attribute, with optional args

getCid

java.lang.Long getCid(java.lang.String attribute,
                    int n)

Return the nth attribute of the named attribute as an id (long), or null if not found

Parameters:

asset -

Returns:

getString

java.lang.String getString(java.lang.String attribute)

Return the first attribute of the the named attribute as a string, or null if not found

Specified by:

getString in interface Content

Parameters:

asset -

Returns:

getString

java.lang.String getString(java.lang.String attribute,
                         int n)

Return the nth named attribute as a string, or null if not found

Specified by:

getString in interface Content

Parameters:

asset -

Returns:

getInt

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

Return the first attribute of the the attribute list as an int, or null if not found

Specified by:

getInt in interface Content

Parameters:

asset -

Returns:

getInt

java.lang.Integer getInt(java.lang.String attribute,
                       int n)

Return the nth attribute of the the attribute list as an int, or null if not found

Specified by:

getInt in interface Content

Parameters:

asset -

Returns:

getLong

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

Return the first attribute of the the attribute list as a long, or null if not found

Specified by:

getLong in interface Content

Parameters:

asset -

Returns:

getLong

java.lang.Long getLong(java.lang.String attribute,
                     int n)

Return the nth attribute of the the attribute list as an int, or null if not found

Specified by:

getLong in interface Content

Parameters:

asset -

Returns:

getDate

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

Return the first attribute of the the attribute list as an int, or null if not found

Specified by:

getDate in interface Content

Parameters:

asset -

Returns:

getDate

java.util.Date getDate(java.lang.String attribute,
                     int n)

Return the nth attribute of the the attribute list as an int, or null if not found

Specified by:

getDate in interface Content

Parameters:

asset -

Returns:

getRange

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

Return an iterable of the attribute list

Specified by:

getRange in interface Content

Parameters:

attribute -

Returns:

getUrl

java.lang.String getUrl(Arg... args)

Return the URL to render this asset

exists

boolean exists(java.lang.String attribute)

Does the attribute exist?

Specified by:

exists in interface Content

Parameters:

attribute -

Returns:

exists

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

Does the nth attribute exist?

Specified by:

exists in interface Content

Parameters:

attribute -

pos -

Returns:

editString

java.lang.String editString(java.lang.String attribute)

Render the attribute as an editable string in insite mode.

Parameters:

attribute -

Returns:

editString

java.lang.String editString(java.lang.String attribute,
                          int n)

Render the nth attribute as an editable string in insite mode.

Parameters:

attribute -

n -

Returns:

editString

java.lang.String editString(java.lang.String attribute,
                          int n,
                          java.lang.String params,
                          Arg... args)

Edit the n-th element of the given attribute, using the given parameters.

Parameters:

attribute -

n -

args -

Returns:

editText

java.lang.String editText(java.lang.String attribute,
                        int n,
                        java.lang.String params)

Edit (or return if not insite) the nth named attribute as a string, or null if not found and pass additional parameters using the CK editor

Parameters:

asset -

Returns:

editString

java.lang.String editString(java.lang.String attribute,
                          java.lang.String params,
                          Arg... args)

Edit (or return if not insite) the first named attribute as a string, or null if not found and pass additional parameters

Parameters:

asset -

args -

Returns:

editText

java.lang.String editText(java.lang.String attribute,
                        java.lang.String params)

Edit (or return if not insite) the first named attribute as a string, or null if not found using the CK editor

Parameters:

asset -

Returns:

call

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

Invoke the template using the current asset as current asset, optionally passing a set of parameters

Parameters:

name -

args -

Returns:

slotList

java.lang.String slotList(java.lang.String field,
                        java.lang.String type,
                        java.lang.String template,
                        Arg... args)
                          throws java.lang.IllegalArgumentException

Render a list of slots pointed by the asset field using the the specified template.

Parameters:

field -

template -

type -

i -

args -

Returns:

Throws:

java.lang.IllegalArgumentException

slotEmpty

java.lang.String slotEmpty(java.lang.String attribute,
                         java.lang.String type,
                         java.lang.String template,
                         java.lang.String emptyText)
                           throws java.lang.IllegalArgumentException

Render an empty slot.

Throws:

java.lang.IllegalArgumentException

slot

java.lang.String slot(java.lang.String attribute,
                    int i,
                    java.lang.String type,
                    java.lang.String template,
                    java.lang.String emptyText,
                    Arg... args)
                      throws java.lang.IllegalArgumentException

Render a single slot pointed by the i-th asset field using the the specified template.

Parameters:

attribute -

template -

type -

i -

args -

Returns:

Throws:

java.lang.IllegalArgumentException

slot

java.lang.String slot(java.lang.String attribute,
                    java.lang.String type,
                    java.lang.String template,
                    java.lang.String emptyText,
                    Arg... args)
                      throws java.lang.IllegalArgumentException

Render a single slot pointed by the first asset field using the the specified template.

Parameters:

attribute -

template - type

template -

args -

Returns:

Throws:

java.lang.IllegalArgumentException