oracle.webcenter.portal.api

Class AssetPropertyBean

java.lang.Object

oracle.webcenter.jaxrs.framework.model.Linked

oracle.webcenter.portal.api.PropertyBean

oracle.webcenter.portal.api.AssetPropertyBean

All Implemented Interfaces:

oracle.webcenter.jaxrs.framework.model.LinkedInterface, AssetProperties

Direct Known Subclasses:

BaseTaskFlowPropertyBean, BusinessObjectPropertyBean, ContentPresenterTemplatePropertyBean, DataServicePropertyBean, LayoutPropertyBean, ResourceCatalogPropertyBean, SkinPropertyBean

public class AssetPropertyBean
extends PropertyBean
implements AssetProperties

Asset Properties.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.webcenter.portal.api.PropertyBean

PropertyBean.SimpleValueHolder<T>

Field Summary

Fields inherited from class oracle.webcenter.jaxrs.framework.model.Linked

links, linkStates, resourceType

Fields inherited from interface oracle.webcenter.jaxrs.framework.model.LinkedInterface

LINK, LINKS

Constructor Summary

Constructors

Constructor and Description
AssetPropertyBean()

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	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.
java.lang.String	linkPath() Set the link prefix for the underlying class to generate correct REST Links.
void	populateLinks(oracle.webcenter.jaxrs.framework.uri.UriService service) Used By REST API to pass in UriService to create auxiliary links
void	removeFromCustomAttributes(java.lang.String key) Removes a custom attribute from the custom attributes collection.
java.lang.String	resourceType()
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 name) 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	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.

Methods inherited from class oracle.webcenter.portal.api.PropertyBean

getCreated, getCreator, getCreatorGuid, getCurrentVersionId, getDescription, getDocumentRef, getId, getLocale, getModified, getModifier, getModifierGuid, getName, getNamespace, getNewVersionId, getPortalShortId, getReference, getSecurityId, getShortId, populateSubLinks, setCreated, setCreator, setCurrentVersionId, setDescription, setDocumentRef, setId, setLocale, setModified, setModifier, setName, setNamespace, setNewVersionId, setPortalShortId, setReference, setSecurityId, setShortId

Methods inherited from class oracle.webcenter.jaxrs.framework.model.Linked

addLink, addLinkState, getLinkElement, getLinks, getLinkURI, getResourceType, linkStates, linkStates, setLinks, setResourceType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.webcenter.portal.api.AssetProperties

getName, setName

Constructor Detail

AssetPropertyBean

public AssetPropertyBean()

Method Detail

resourceType

public java.lang.String resourceType()

Specified by:

resourceType in interface oracle.webcenter.jaxrs.framework.model.LinkedInterface

Specified by:

resourceType in class PropertyBean

populateLinks

public void populateLinks(oracle.webcenter.jaxrs.framework.uri.UriService service)

Used By REST API to pass in UriService to create auxiliary links

Overrides:

populateLinks in class PropertyBean

Parameters:

service - UriService

linkPath

public java.lang.String linkPath()

Set the link prefix for the underlying class to generate correct REST Links.

getDisplayNameKey

public java.lang.String getDisplayNameKey()

Gets the display name key property.

Specified by:

getDisplayNameKey in interface AssetProperties

Returns:

the display name key property.

setDisplayNameKey

public void setDisplayNameKey(java.lang.String displayNameKey)

Sets the display name key property.

Specified by:

setDisplayNameKey in interface AssetProperties

Parameters:

displayNameKey - the display name key property to set.

getDescriptionKey

public java.lang.String getDescriptionKey()

Gets the description key.

Specified by:

getDescriptionKey in interface AssetProperties

Returns:

the description key.

setDescriptionKey

public void setDescriptionKey(java.lang.String descriptionKey)

Sets the description key.

Specified by:

setDescriptionKey in interface AssetProperties

Parameters:

descriptionKey - the description key to set.

getResourceBundle

public java.lang.String getResourceBundle()

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

Specified by:

getResourceBundle in interface AssetProperties

Returns:

the resource bundle.

setResourceBundle

public void setResourceBundle(java.lang.String resourceBundle)

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

Specified by:

setResourceBundle in interface AssetProperties

Parameters:

resourceBundle - the resource bundle to set.

getContentDir

public java.lang.String getContentDir()

Gets the content directory property.

Specified by:

getContentDir in interface AssetProperties

Returns:

the content directory property.

setContentDir

public void setContentDir(java.lang.String contentDir)

Sets the content directory property.

Specified by:

setContentDir in interface AssetProperties

Parameters:

contentDir - the content directory property to set.

getIconURI

public java.lang.String getIconURI()

Gets the icon URI.

Specified by:

getIconURI in interface AssetProperties

Returns:

the icon URI.

setIconURI

public void setIconURI(java.lang.String iconURI)

Sets the ico URI.

Specified by:

setIconURI in interface AssetProperties

Parameters:

iconURI - the ico URI to set.

getLogoURL

public java.lang.String getLogoURL()

Gets the logo URL.

Specified by:

getLogoURL in interface AssetProperties

Returns:

the logo URL.

setLogoURL

public void setLogoURL(java.lang.String logoURL)

Sets the logo URL.

Specified by:

setLogoURL in interface AssetProperties

Parameters:

logoURL - the logo URL to set.

getCategory

public java.lang.String getCategory()

Gets the category.

Specified by:

getCategory in interface AssetProperties

Returns:

the category.

setCategory

public void setCategory(java.lang.String category)

Sets the category.

Specified by:

setCategory in interface AssetProperties

Parameters:

category - the category to set.

getLockedBy

public java.lang.String getLockedBy()

Gets the locked by property.

Specified by:

getLockedBy in interface AssetProperties

Returns:

the locked by property.

setLockedBy

public void setLockedBy(java.lang.String lockedBy)

Sets the locked by property.

Specified by:

setLockedBy in interface AssetProperties

Parameters:

lockedBy - the locked by property to set.

getLockedDate

public java.util.Date getLockedDate()

Gets the locked date.

Specified by:

getLockedDate in interface AssetProperties

Returns:

the locked date.

setLockedDate

public void setLockedDate(java.util.Date lockedDate)

Sets the locked date.

Specified by:

setLockedDate in interface AssetProperties

Parameters:

lockedDate - the locked date to set.

getSeeded

public boolean getSeeded()

Gets the seeded property.

Specified by:

getSeeded in interface AssetProperties

Returns:

the seeded property.

setSeeded

public void setSeeded(boolean seeded)

Sets the seeded property.

Specified by:

setSeeded in interface AssetProperties

Parameters:

seeded - the seeded property to set.

getVisible

public boolean getVisible()

Gets the visible property.

Specified by:

getVisible in interface AssetProperties

Returns:

the visible property.

setVisible

public void setVisible(boolean visible)

Sets the visible property.

Specified by:

setVisible in interface AssetProperties

Parameters:

visible - the visible property to set.

getUsesCustomSecurity

public boolean getUsesCustomSecurity()

Gets the uses custom security property.

Specified by:

getUsesCustomSecurity in interface AssetProperties

Returns:

the uses custom security property.

setUsesCustomSecurity

public void setUsesCustomSecurity(boolean usesCustomSecurity)

Sets the uses custom security property.

Specified by:

setUsesCustomSecurity in interface AssetProperties

Parameters:

usesCustomSecurity - the uses custom security property to set.

getExcludedFrom

public AssetResource.ExcludedFrom getExcludedFrom()

Gets the excluded from property.

Specified by:

getExcludedFrom in interface AssetProperties

Returns:

the excluded from property.

setExcludedFrom

public void setExcludedFrom(AssetResource.ExcludedFrom excludedFrom)

Sets the excluded from property.

Specified by:

setExcludedFrom in interface AssetProperties

Parameters:

excludedFrom - the excluded from property to set.

getExcludedPortalIds

public java.lang.String getExcludedPortalIds()

Gets the excluded portal ids.

Specified by:

getExcludedPortalIds in interface AssetProperties

Returns:

the excluded portal ids.

setExcludedPortalIds

public void setExcludedPortalIds(java.lang.String excludedPortalIds)

Sets the excluded portal ids.

Specified by:

setExcludedPortalIds in interface AssetProperties

Parameters:

excludedPortalIds - the excluded portal ids to set.

getCustomAttributes

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

Gets the custom attributes map.

Specified by:

getCustomAttributes in interface AssetProperties

Returns:

the custom attributes map.

addToCustomAttributes

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

Adds a custom attribute to the custom atributes collection.

Specified by:

addToCustomAttributes in interface AssetProperties

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

public void removeFromCustomAttributes(java.lang.String key)

Removes a custom attribute from the custom attributes collection.

Specified by:

removeFromCustomAttributes in interface AssetProperties

Parameters:

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

setCustomAttributes

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

Sets the custom attributes map.

Specified by:

setCustomAttributes in interface AssetProperties

Parameters:

customAttributes - the custom attributes map to set.

clearCustomAttributes

public void clearCustomAttributes()

Clears all the attributes from the custom attributes collection.

Specified by:

clearCustomAttributes in interface AssetProperties

setDisplayName

public void setDisplayName(java.lang.String name)

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.

Specified by:

setDisplayName in interface AssetProperties

Parameters:

name - The display name.

getDisplayName

public 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.

Specified by:

getDisplayName in interface AssetProperties

Returns:

setTranslatedDescription

public 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.

Specified by:

setTranslatedDescription in interface AssetProperties

Parameters:

translatedDescription - the translated description.

getTranslatedDescription

public java.lang.String getTranslatedDescription()

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

Specified by:

getTranslatedDescription in interface AssetProperties

Returns:

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