com.sas.edir.webapp
Interface ContentItem

All Superinterfaces:

Caching, Entity, KeywordEntity, TrackedObject

All Known Subinterfaces:

Application, ContentChannel, ContentDocument, Link, WebEisDocument, Widget

public interface ContentItem

extends KeywordEntity

Content item interface.

Version:

1.0

Author:

SAS

Fields inherited from interface com.sas.edir.Entity

PROPERTY_CHANGED, SUBPROPERTY_CHANGED

Method Summary

void	addAttribute(java.lang.String attribute) Adds an attribute to this content item.
void	addParameter(java.lang.String parameter) Adds a parameter to a content item.
java.util.Iterator	getAttributeIterator() Returns the attributes for this content item.
java.lang.String	getContentDescription() Returns the content description.
java.lang.String	getEmbeddedContent() Returns the Embedded content if the provider type is embedded.
java.lang.String	getEmbeddedXsl() Returns the XSL to use to format XML for this content.
java.lang.String	getFormatCharacteristics() Returns the Format Characteristics of the item
java.lang.String	getJsp() Returns the JSP used to render this content element
java.lang.String	getLabel() Returns the item's label.
java.lang.String	getMimeType() Returns the item's MIME type
java.util.Iterator	getParameterIterator() Returns the Parameters for the content item.
java.lang.String	getPath() Returns the file system path to this content item.
java.lang.String	getProviderType() Returns the provider type for the content.
java.lang.String	getPublisher() Returns the DN of the publisher of this content.
java.lang.String	getUrl() Returns the URL used to access this content.
java.lang.String	getUsage() Returns the URL containing usage information about this content.
java.lang.String	getXsl() Returns the URL containing the XSL to use with this content.
void	removeAttribute(java.lang.String attribute) Remove an attribute from the list.
void	removeParameter(Parameter parameter) Removes a parameter from a content item.
void	setContentDescription(java.lang.String contentDescription) Sets the content description.
void	setEmbeddedContent(java.lang.String embeddedContent) Sets the embedded content.
void	setEmbeddedXsl(java.lang.String newXsl) Sets the XSL to use to format XML for this content.
void	setFormatCharacteristics(java.lang.String formatCharacter) Sets the Format Characteristics of the item.
void	setJsp(java.lang.String jsp) Sets the JSP to use to render this content.
void	setLabel(java.lang.String label) Sets the item's label.
void	setMimeType(java.lang.String mimeType) Set the item's MIME type.
void	setPath(java.lang.String path) Sets the file system path to this content item.
void	setProviderType(java.lang.String providerType) Sets the provider type for a content item.
void	setPublisher(java.lang.String publisher) Sets the DN of the user who published the content.
void	setUrl(java.lang.String url) Sets the URL used to access this content.
void	setUsage(java.lang.String usageUrl) Sets the URL providing usage information about this content item.
void	setXsl(java.lang.String xsl) Sets the URL containing the XSL for this item.

Methods inherited from interface com.sas.edir.KeywordEntity

addKeyword, keywordIterator, keywordIterator, removeKeyword, setKeywords

Methods inherited from interface com.sas.edir.Entity

addPropertyChangeListener, getContext, getCreateTime, getCreatorsName, getDescription, getEnterpriseDirectory, getGuid, getModifiersName, getModifyTime, getName, getObjectclass, removeModificationItems, removePropertyChangeListener, setDescription, setGuid, setName, setObjectclass

Methods inherited from interface com.sas.edir.Caching

edirUpdateStore, getTimeToLive, isExpired, refreshCache, refreshCachedObjects, releaseCache, setDirty, setTimeToLive, setTimeToLive, updateStore

Methods inherited from interface com.sas.edir.TrackedObject

getTrackingId, getUserData, setUserData

Method Detail

getMimeType

public java.lang.String getMimeType()

Returns the item's MIME type

Returns:

The MIME type as a String

setMimeType

public void setMimeType(java.lang.String mimeType)

Set the item's MIME type.

Parameters:

The - new MIME type for the entry.

getFormatCharacteristics

public java.lang.String getFormatCharacteristics()

Returns the Format Characteristics of the item

Returns:

the format characteristics as a String.

setFormatCharacteristics

public void setFormatCharacteristics(java.lang.String formatCharacter)

Sets the Format Characteristics of the item.

Parameters:

The - string representation of the format characteristics.

getLabel

public java.lang.String getLabel()

Returns the item's label.

Returns:

The content label as a String.

setLabel

public void setLabel(java.lang.String label)

Sets the item's label.

Parameters:

The - new item label.

getAttributeIterator

public java.util.Iterator getAttributeIterator()

Returns the attributes for this content item.

Returns:

The attributes to pass to the JSP for this item.

addAttribute

public void addAttribute(java.lang.String attribute)

Adds an attribute to this content item.

Parameters:

an - attribute to add to the list.

removeAttribute

public void removeAttribute(java.lang.String attribute)

Remove an attribute from the list.

Parameters:

The - Attribute to remove.

getParameterIterator

public java.util.Iterator getParameterIterator()

Returns the Parameters for the content item.

Returns:

An Iterator containing the parameter items.

addParameter

public void addParameter(java.lang.String parameter)

Adds a parameter to a content item.

Parameters:

A - parameter to add to the list.

removeParameter

public void removeParameter(Parameter parameter)

Removes a parameter from a content item.

Parameters:

A - parameter to remove from the list.

getProviderType

public java.lang.String getProviderType()

Returns the provider type for the content.

Returns:

The provider type for this content item.

setProviderType

public void setProviderType(java.lang.String providerType)

Sets the provider type for a content item.

Parameters:

The - new provider type.

getEmbeddedContent

public java.lang.String getEmbeddedContent()

Returns the Embedded content if the provider type is embedded.

Returns:

The embedded content.

setEmbeddedContent

public void setEmbeddedContent(java.lang.String embeddedContent)

Sets the embedded content.

Parameters:

The - embedded content.

getJsp

public java.lang.String getJsp()

Returns the JSP used to render this content element

Returns:

the JSP name for this content.

setJsp

public void setJsp(java.lang.String jsp)

Sets the JSP to use to render this content.

Parameters:

The - new JSP to use.

getUrl

public java.lang.String getUrl()

Returns the URL used to access this content.

Returns:

The content URL.

setUrl

public void setUrl(java.lang.String url)

Sets the URL used to access this content.

Parameters:

The - new URL.

getPath

public java.lang.String getPath()

Returns the file system path to this content item.

Returns:

the file system path.

setPath

public void setPath(java.lang.String path)

Sets the file system path to this content item.

Parameters:

The - file system path.

getPublisher

public java.lang.String getPublisher()

Returns the DN of the publisher of this content.

Returns:

the DN of the user who published the content.

setPublisher

public void setPublisher(java.lang.String publisher)

Sets the DN of the user who published the content.

Parameters:

The - new DN of the publisher.

getUsage

public java.lang.String getUsage()

Returns the URL containing usage information about this content.

Returns:

the usage URL for this content.

setUsage

public void setUsage(java.lang.String usageUrl)

Sets the URL providing usage information about this content item.

Parameters:

The - new usage URL.

getEmbeddedXsl

public java.lang.String getEmbeddedXsl()

Returns the XSL to use to format XML for this content.

Returns:

The XML formatting XSL.

setEmbeddedXsl

public void setEmbeddedXsl(java.lang.String newXsl)

Sets the XSL to use to format XML for this content.

Parameters:

The - new XSL to use.

getXsl

public java.lang.String getXsl()

Returns the URL containing the XSL to use with this content.

Returns:

The URL to the XSL.

setXsl

public void setXsl(java.lang.String xsl)

Sets the URL containing the XSL for this item.

Parameters:

the - XSL URL.

getContentDescription

public java.lang.String getContentDescription()

Returns the content description. This represents the type of content for this entry.

Returns:

The content description

setContentDescription

public void setContentDescription(java.lang.String contentDescription)

Sets the content description.

Parameters:

The - new content description.