Skip navigation links

com.stellent.cis.client.api.common
Interface ICISObject

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ICISAdapterConfig, ICISCheckinResponse, ICISContent, ICISContentPage, ICISID, ICISSavedSearch, ICISSearchCookie, ICISSearchPrompt, ISCSActionContent, ISCSAdapterConfig, ISCSCacheConfig, ISCSCachePolicy, ISCSCheckedOutListResponse, ISCSCheckinFlags, ISCSCheckinInfoResponse, ISCSCheckinSimilarInfoResponse, ISCSCheckinValidateResponse, ISCSCISDocInfoResponse, ISCSCISFileLocationResponse, ISCSCISGetFileResponse, ISCSContent, ISCSContentID, ISCSContentPage, ISCSContentSubscription, ISCSConvertedDisplayInfo, ISCSConvertedFileInfo, ISCSCredentialValidateResponse, ISCSDocFormat, ISCSDocMetaDefinition, ISCSDocType, ISCSDocTypesResponse, ISCSDocumentActionResponse, ISCSDocumentCheckinResponse, ISCSDocumentConfigurationResponse, ISCSDocumentEventData, ISCSDocumentID, ISCSDocumentInformationResponse, ISCSDynamicConversionResponse, ISCSDynamicConvertedContent, ISCSDynamicConverterConfigResponse, ISCSDynamicConverterTemplate, ISCSEventPollerInfo, ISCSFileCacheInfo, ISCSFileCachePolicy, ISCSFileInfo, ISCSFileLocation, ISCSFileRetrievalInfo, ISCSFolder, ISCSFolderAddLinkResponse, ISCSFolderContent, ISCSFolderDeleteContentResponse, ISCSFolderDisplayResponse, ISCSFolderHierarchyResponse, ISCSFolderID, ISCSFolderInfoResponse, ISCSFolderListContentsResponse, ISCSFolderListFoldersResponse, ISCSFolderMovedContent, ISCSFolderMovedFolder, ISCSFolderMultiNodeResponse, ISCSFolderPathID, ISCSFolderReferenceResponse, ISCSFolderSearchResponse, ISCSFolderSingleNodeResponse, ISCSID, ISCSInfoContent, ISCSInternalID, ISCSItem, ISCSLinkID, ISCSLocaleConfig, ISCSLocaleGetDataResponse, ISCSLocaleISOMapping, ISCSLocaleTimeZone, ISCSMetaDataEditResponse, ISCSMultisortSearchQuery, ISCSObject, ISCSOptionList, ISCSPingResponse, ISCSQueryDocumentEventsResponse, ISCSQueryUserAttributesResponse, ISCSRevisionHistory, ISCSRevisionNode, ISCSRoleListResponse, ISCSSavedLink, ISCSSavedSearch, ISCSSchemaField, ISCSSchemaFieldDefinition, ISCSSchemaFieldsResponse, ISCSSchemaFragmentResponse, ISCSSearchNavigationPage, ISCSSearchQuery, ISCSSearchResponse, ISCSSearchResult, ISCSServerBinder, ISCSServerComponent, ISCSServerComponentsResponse, ISCSServerFilterInfo, ISCSServerResponse, ISCSServiceCacheInfo, ISCSServiceCachePolicy, ISCSSQLQuery, ISCSSubscribeResponse, ISCSSubscription, ISCSSubscriptionBasicID, ISCSSubscriptionContentItemsResponse, ISCSSubscriptionContentListResponse, ISCSSubscriptionCriteriaID, ISCSSubscriptionID, ISCSSubscriptionNotifyUpdateResponse, ISCSSubscriptionUserListResponse, ISCSUnsubscribeResponse, ISCSUserAccount, ISCSUserActionResponse, ISCSUserAlias, ISCSUserAliasActionResponse, ISCSUserAliasMapping, ISCSUserAttributeInfo, ISCSUserListAliasesResponse, ISCSUserListResponse, ISCSUserMetaDefinition, ISCSUserObject, ISCSUserPNEObject, ISCSUserPNEResponse, ISCSUserRole, ISCSUserRoleActionResponse, ISCSUserSecurityGroup, ISCSUserSecurityObject, ISCSWorkflow, ISCSWorkflowAction, ISCSWorkflowActionResponse, ISCSWorkflowApproveRejectResponse, ISCSWorkflowDocument, ISCSWorkflowDocumentRevisionsResponse, ISCSWorkflowDocumentsResponse, ISCSWorkflowID, ISCSWorkflowQueryResponse, ISCSWorkflowQueueItem, ISCSWorkflowQueueResponse, ISCSWorkflowResponse, ISCSWorkflowScriptJump, ISCSWorkflowStartResponse, ISCSWorkflowStep, ISCSWorkflowStepEvent, ISCSWorkflowStepID, ISCSWorkflowStepInfoResponse, ISCSWorkflowTemplate, ISCSWorkflowTemplateResponse, ISCSWorkflowTemplatesResponse, ISISAdapterConfig, ISISAdhocPrompt, ISISAdhocQuery, ISISApplication, ISISApplicationResponse, ISISComparisonOperator, ISISContent, ISISContentPage, ISISCreateDocumentRequest, ISISCreateDocumentResponse, ISISCreatePackage, ISISCreatePackageResult, ISISID, ISISLogicalOperator, ISISObject, ISISOptionList, ISISPackage, ISISPackageAttachment, ISISPackageDecision, ISISPackageField, ISISPackageFieldOptionList, ISISPackageResult, ISISPackageTemplate, ISISPlaceInFlow, ISISPlaceInFlowRequest, ISISProcessOperator, ISISProcessProfile, ISISProfilePrompt, ISISPromptedProfile, ISISSavedSearch, ISISSearchCookie, ISISSearchPrompt, ISISSearchResponse, ISISTemplateField, ISISTemplateStartEvent, ISISUserField

public interface ICISObject

extends java.io.Serializable

Base interface for all objects with metadata in the Universal Content Mangement API.

Field Summary

static int	FILTER_NULL_VALUE
static int	FILTER_READONLY
static int	FILTER_SYSTEM

Method Summary

java.util.Collection	getProperties()
java.util.Collection	getPropertiesWithValue()
ICISProperty	getProperty(java.lang.String name) Retrieve the value for a given property
java.lang.String	getPropertyAsString(java.lang.String name) Retrieve the property as a String.
java.lang.String	getPropertyAsString(java.lang.String name, java.lang.String defaultValue) Retrieve the property value as a String.
java.util.Collection	getPropertyDescriptors() Retrieve the property descriptors for all exposed properties
boolean	hasProperty(java.lang.String name) Determines if there is a property on this object with the given name
void	setProperty(java.lang.String name, ICISPropertyValue value) Set the property value
void	setProperty(java.lang.String name, ICISPropertyValue value, ICISPropertyDescriptor descriptor) Set a complete property
void	setProperty(java.lang.String name, java.lang.Object value) Set the property value

Field Detail

FILTER_READONLY

static final int FILTER_READONLY

See Also:

Constant Field Values

FILTER_SYSTEM

static final int FILTER_SYSTEM

See Also:

Constant Field Values

FILTER_NULL_VALUE

static final int FILTER_NULL_VALUE

See Also:

Constant Field Values

Method Detail

getProperty

ICISProperty getProperty(java.lang.String name)

Retrieve the value for a given property

Parameters:

name - the name of the property to retrieve

Returns:

the attribute value or null if no such attribute exists

getPropertyAsString

java.lang.String getPropertyAsString(java.lang.String name)

Retrieve the property as a String. Shortcut for calling getProperty ("property").getValue ().getStringValue ()

Parameters:

name - the property name

Returns:

the property value (can be null)

getPropertyAsString

java.lang.String getPropertyAsString(java.lang.String name,
                                     java.lang.String defaultValue)

Retrieve the property value as a String. If the property value is not found, the default value is returned

Parameters:

name - the property name

defaultValue - the default value

Returns:

the property value or the default value if the property value is null

hasProperty

boolean hasProperty(java.lang.String name)

Determines if there is a property on this object with the given name

Parameters:

name - the property name

Returns:

true if such a property exists

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object value)

Set the property value

Parameters:

name - the property name

value - the property value

setProperty

void setProperty(java.lang.String name,
                 ICISPropertyValue value)

Set the property value

Parameters:

name - the property name

value - the property value

setProperty

void setProperty(java.lang.String name,
                 ICISPropertyValue value,
                 ICISPropertyDescriptor descriptor)
                 throws PropertySetException

Set a complete property

Parameters:

name - the property name

value - the property value

descriptor - the descriptor for the property

Throws:

PropertySetException - if an error occurs during the setting of a property

getProperties

java.util.Collection getProperties()

Returns:

the complete list of available ICISProperty objects

getPropertyDescriptors

java.util.Collection getPropertyDescriptors()

Retrieve the property descriptors for all exposed properties

Returns:

the property descriptors

getPropertiesWithValue

java.util.Collection getPropertiesWithValue()

Returns:

retrieve all ICISProperty objects which contain a value

Skip navigation links