oracle.webcenter.portal.api

Interface AssetProperties

All Known Implementing Classes:

AssetPropertyBean, BaseTaskFlowPropertyBean, BusinessObjectPropertyBean, ContentPresenterTemplatePropertyBean, DataServicePropertyBean, DpTaskFlowPropertyBean, LayoutPropertyBean, PageStylePropertyBean, PageTemplatePropertyBean, ResourceCatalogPropertyBean, RESTDataServicePropertyBean, SkinPropertyBean, SOAPDataServicePropertyBean, SQLDataServicePropertyBean, TaskFlowPropertyBean, VisualizationTemplatePropertyBean

public interface AssetProperties

Super-interface for all Portal Assets. This interface defines the setters and getters of the common attributes or properties of all Portal Assets.

Method Summary

Modifier and Type	Method and Description
void	addToCustomAttributes(java.lang.String key, java.lang.String value) Adds a custom attribute to the custom atributes collection.
void	clearCustomAttributes() Clears all the attributes from the custom attributes collection.
java.lang.String	getCategory() Gets the category.
java.lang.String	getContentDir() Gets the content directory property.
java.util.Map<java.lang.String,java.lang.String>	getCustomAttributes() Gets the custom attributes map.
java.lang.String	getDescriptionKey() Gets the description key.
java.lang.String	getDisplayName() Gets the display name of the Portal Asset, note if the resourceBundle and displayNameKey properties are valid the display name will be derived from those, otherwise the display name will be derived from the name property of the asset.
java.lang.String	getDisplayNameKey() Gets the display name key property.
AssetResource.ExcludedFrom	getExcludedFrom() Gets the excluded from property.
java.lang.String	getExcludedPortalIds() Gets the excluded portal ids.
java.lang.String	getIconURI() Gets the icon URI.
java.lang.String	getLockedBy() Gets the locked by property.
java.util.Date	getLockedDate() Gets the locked date.
java.lang.String	getLogoURL() Gets the logo URL.
java.lang.String	getName() Gets the name of the asset.
java.lang.String	getResourceBundle() Gets the resource bundle, used to obtain associated key based properties such as displayNameKey and descriptionKey.
boolean	getSeeded() Gets the seeded property.
java.lang.String	getTranslatedDescription() Gets the translated description.
boolean	getUsesCustomSecurity() Gets the uses custom security property.
boolean	getVisible() Gets the visible property.
void	removeFromCustomAttributes(java.lang.String key) Removes a custom attribute from the custom attributes collection.
void	setCategory(java.lang.String category) Sets the category.
void	setContentDir(java.lang.String contentDir) Sets the content directory property.
void	setCustomAttributes(java.util.Map<java.lang.String,java.lang.String> customAttributes) Sets the custom attributes map.
void	setDescriptionKey(java.lang.String descriptionKey) Sets the description key.
void	setDisplayName(java.lang.String displayName) Sets the display name of the property.
void	setDisplayNameKey(java.lang.String displayNameKey) Sets the display name key property.
void	setExcludedFrom(AssetResource.ExcludedFrom excludedFrom) Sets the excluded from property.
void	setExcludedPortalIds(java.lang.String excludedPortalIds) Sets the excluded portal ids.
void	setIconURI(java.lang.String iconURI) Sets the ico URI.
void	setLockedBy(java.lang.String lockedBy) Sets the locked by property.
void	setLockedDate(java.util.Date lockedDate) Sets the locked date.
void	setLogoURL(java.lang.String logoURL) Sets the logo URL.
void	setName(java.lang.String name) Sets the name of the asset.
void	setResourceBundle(java.lang.String resourceBundle) Sets the resource bundle, used to obtain associated key based properties such as displayNameKey and descriptionKey.
void	setSeeded(boolean seeded) Sets the seeded property.
void	setTranslatedDescription(java.lang.String translatedDescription) Sets the translated description property.
void	setUsesCustomSecurity(boolean usesCustomSecurity) Sets the uses custom security property.
void	setVisible(boolean visible) Sets the visible property.

Method Detail

getName

java.lang.String getName()

Gets the name of the asset.

Returns:

the name of the asset.

setName

void setName(java.lang.String name)

Sets the name of the asset.

Parameters:

name - the name of the asset to set.

getDisplayName

java.lang.String getDisplayName()

Gets the display name of the Portal Asset, note if the resourceBundle and displayNameKey properties are valid the display name will be derived from those, otherwise the display name will be derived from the name property of the asset.

Returns:

setDisplayName

void setDisplayName(java.lang.String displayName)

Sets the display name of the property. If there is a displayNameKey and resourceBundle property associated with this asset and that matches the value being set no change will take place to the displayName and resourceBundle values, however, if divergent the displayNameKey property will be nulled as a set of a different displayName indicates the resource bundle and key based lookup is no longer required.

Parameters:

displayName - The display name.

getDisplayNameKey

java.lang.String getDisplayNameKey()

Gets the display name key property.

Returns:

the display name key property.

setDisplayNameKey

void setDisplayNameKey(java.lang.String displayNameKey)

Sets the display name key property.

Parameters:

displayNameKey - the display name key property to set.

getTranslatedDescription

java.lang.String getTranslatedDescription()

Gets the translated description. If no description key exists then the value set against description will be returned.

Returns:

The translated description, or description value if no valid description key and resource bundle are set.

setTranslatedDescription

void setTranslatedDescription(java.lang.String translatedDescription)

Sets the translated description property. Note this is only to be used for bean update purposes and the value set will not be passed back to be persisted. To persist description changes the setDescription and setDescriptionKey methods should be used.

Parameters:

translatedDescription - the translated description.

getDescriptionKey

java.lang.String getDescriptionKey()

Gets the description key.

Returns:

the description key.

setDescriptionKey

void setDescriptionKey(java.lang.String descriptionKey)

Sets the description key.

Parameters:

descriptionKey - the description key to set.

getResourceBundle

java.lang.String getResourceBundle()

Gets the resource bundle, used to obtain associated key based properties such as displayNameKey and descriptionKey.

Returns:

the resource bundle.

setResourceBundle

void setResourceBundle(java.lang.String resourceBundle)

Sets the resource bundle, used to obtain associated key based properties such as displayNameKey and descriptionKey.

Parameters:

resourceBundle - the resource bundle to set.

getContentDir

java.lang.String getContentDir()

Gets the content directory property.

Returns:

the content directory property.

setContentDir

void setContentDir(java.lang.String contentDir)

Sets the content directory property.

Parameters:

contentDir - the content directory property to set.

getIconURI

java.lang.String getIconURI()

Gets the icon URI.

Returns:

the icon URI.

setIconURI

void setIconURI(java.lang.String iconURI)

Sets the ico URI.

Parameters:

iconURI - the ico URI to set.

getLogoURL

java.lang.String getLogoURL()

Gets the logo URL.

Returns:

the logo URL.

setLogoURL

void setLogoURL(java.lang.String logoURL)

Sets the logo URL.

Parameters:

logoURL - the logo URL to set.

getCategory

java.lang.String getCategory()

Gets the category.

Returns:

the category.

setCategory

void setCategory(java.lang.String category)

Sets the category.

Parameters:

category - the category to set.

getLockedBy

java.lang.String getLockedBy()

Gets the locked by property.

Returns:

the locked by property.

setLockedBy

void setLockedBy(java.lang.String lockedBy)

Sets the locked by property.

Parameters:

lockedBy - the locked by property to set.

getLockedDate

java.util.Date getLockedDate()

Gets the locked date.

Returns:

the locked date.

setLockedDate

void setLockedDate(java.util.Date lockedDate)

Sets the locked date.

Parameters:

lockedDate - the locked date to set.

getSeeded

boolean getSeeded()

Gets the seeded property.

Returns:

the seeded property.

setSeeded

void setSeeded(boolean seeded)

Sets the seeded property.

Parameters:

seeded - the seeded property to set.

getVisible

boolean getVisible()

Gets the visible property.

Returns:

the visible property.

setVisible

void setVisible(boolean visible)

Sets the visible property.

Parameters:

visible - the visible property to set.

getUsesCustomSecurity

boolean getUsesCustomSecurity()

Gets the uses custom security property.

Returns:

the uses custom security property.

setUsesCustomSecurity

void setUsesCustomSecurity(boolean usesCustomSecurity)

Sets the uses custom security property.

Parameters:

usesCustomSecurity - the uses custom security property to set.

getExcludedFrom

AssetResource.ExcludedFrom getExcludedFrom()

Gets the excluded from property.

Returns:

the excluded from property.

setExcludedFrom

void setExcludedFrom(AssetResource.ExcludedFrom excludedFrom)

Sets the excluded from property.

Parameters:

excludedFrom - the excluded from property to set.

getExcludedPortalIds

java.lang.String getExcludedPortalIds()

Gets the excluded portal ids.

Returns:

the excluded portal ids.

setExcludedPortalIds

void setExcludedPortalIds(java.lang.String excludedPortalIds)

Sets the excluded portal ids.

Parameters:

excludedPortalIds - the excluded portal ids to set.

getCustomAttributes

java.util.Map<java.lang.String,java.lang.String> getCustomAttributes()

Gets the custom attributes map.

Returns:

the custom attributes map.

setCustomAttributes

void setCustomAttributes(java.util.Map<java.lang.String,java.lang.String> customAttributes)

Sets the custom attributes map.

Parameters:

customAttributes - the custom attributes map to set.

addToCustomAttributes

void addToCustomAttributes(java.lang.String key,
                           java.lang.String value)

Adds a custom attribute to the custom atributes collection.

Parameters:

key - the key of the custom attribute being added to the custom attributes collection.

value - the value of the custom attribute being added to the custom attributes collection.

removeFromCustomAttributes

void removeFromCustomAttributes(java.lang.String key)

Removes a custom attribute from the custom attributes collection.

Parameters:

key - the key of the custom attribute to be removed from the custom attributes collection.

clearCustomAttributes

void clearCustomAttributes()

Clears all the attributes from the custom attributes collection.