Package 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
@Exported 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 Details

    • getName

      String getName()
      Gets the name of the asset.
      Returns:
      the name of the asset.

    • setName

      void setName(String name)
      Sets the name of the asset.
      Parameters:
      name - the name of the asset to set.

    • getDisplayName

      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(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

      String getDisplayNameKey()
      Gets the display name key property.
      Returns:
      the display name key property.

    • setDisplayNameKey

      void setDisplayNameKey(String displayNameKey)
      Sets the display name key property.
      Parameters:
      displayNameKey - the display name key property to set.

    • getTranslatedDescription

      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(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

      String getDescriptionKey()
      Gets the description key.
      Returns:
      the description key.

    • setDescriptionKey

      void setDescriptionKey(String descriptionKey)
      Sets the description key.
      Parameters:
      descriptionKey - the description key to set.

    • getResourceBundle

      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(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

      String getContentDir()
      Gets the content directory property.
      Returns:
      the content directory property.

    • setContentDir

      void setContentDir(String contentDir)
      Sets the content directory property.
      Parameters:
      contentDir - the content directory property to set.

    • getIconURI

      String getIconURI()
      Gets the icon URI.
      Returns:
      the icon URI.

    • setIconURI

      void setIconURI(String iconURI)
      Sets the ico URI.
      Parameters:
      iconURI - the ico URI to set.

    • getLogoURL

      String getLogoURL()
      Gets the logo URL.
      Returns:
      the logo URL.

    • setLogoURL

      void setLogoURL(String logoURL)
      Sets the logo URL.
      Parameters:
      logoURL - the logo URL to set.

    • getCategory

      String getCategory()
      Gets the category.
      Returns:
      the category.

    • setCategory

      void setCategory(String category)
      Sets the category.
      Parameters:
      category - the category to set.

    • getLockedBy

      String getLockedBy()
      Gets the locked by property.
      Returns:
      the locked by property.

    • setLockedBy

      void setLockedBy(String lockedBy)
      Sets the locked by property.
      Parameters:
      lockedBy - the locked by property to set.

    • getLockedDate

      Date getLockedDate()
      Gets the locked date.
      Returns:
      the locked date.

    • setLockedDate

      void setLockedDate(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

      String getExcludedPortalIds()
      Gets the excluded portal ids.
      Returns:
      the excluded portal ids.

    • setExcludedPortalIds

      void setExcludedPortalIds(String excludedPortalIds)
      Sets the excluded portal ids.
      Parameters:
      excludedPortalIds - the excluded portal ids to set.

    • getCustomAttributes

      Map<String,String> getCustomAttributes()
      Gets the custom attributes map.
      Returns:
      the custom attributes map.

    • setCustomAttributes

      void setCustomAttributes(Map<String,String> customAttributes)
      Sets the custom attributes map.
      Parameters:
      customAttributes - the custom attributes map to set.

    • addToCustomAttributes

      void addToCustomAttributes(String key, 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(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.