com.stellent.cis.client.api.scs
Interface ISCSServerResponse

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSObject, ISCSServerBinder, java.io.Serializable

All Known Subinterfaces:

ISCSCheckedOutListResponse, ISCSCheckinInfoResponse, ISCSCheckinSimilarInfoResponse, ISCSCheckinValidateResponse, ISCSCISDocInfoResponse, ISCSCISFileLocationResponse, ISCSCISGetFileResponse, ISCSCredentialValidateResponse, ISCSDocTypesResponse, ISCSDocumentActionResponse, ISCSDocumentCheckinResponse, ISCSDocumentConfigurationResponse, ISCSDocumentInformationResponse, ISCSDynamicConversionResponse, ISCSDynamicConverterConfigResponse, ISCSFolderAddLinkResponse, ISCSFolderDeleteContentResponse, ISCSFolderDisplayResponse, ISCSFolderHierarchyResponse, ISCSFolderInfoResponse, ISCSFolderListContentsResponse, ISCSFolderListFoldersResponse, ISCSFolderMultiNodeResponse, ISCSFolderReferenceResponse, ISCSFolderSearchResponse, ISCSFolderSingleNodeResponse, ISCSLocaleGetDataResponse, ISCSMetaDataEditResponse, ISCSPingResponse, ISCSQueryDocumentEventsResponse, ISCSQueryUserAttributesResponse, ISCSRoleListResponse, ISCSSchemaFieldsResponse, ISCSSchemaFragmentResponse, ISCSSearchResponse, ISCSServerComponentsResponse, ISCSSubscribeResponse, ISCSSubscriptionContentItemsResponse, ISCSSubscriptionContentListResponse, ISCSSubscriptionNotifyUpdateResponse, ISCSSubscriptionUserListResponse, ISCSUnsubscribeResponse, ISCSUserActionResponse, ISCSUserAliasActionResponse, ISCSUserListAliasesResponse, ISCSUserListResponse, ISCSUserPNEResponse, ISCSUserRoleActionResponse, ISCSWorkflowActionResponse, ISCSWorkflowApproveRejectResponse, ISCSWorkflowDocumentRevisionsResponse, ISCSWorkflowDocumentsResponse, ISCSWorkflowQueryResponse, ISCSWorkflowQueueResponse, ISCSWorkflowResponse, ISCSWorkflowStartResponse, ISCSWorkflowStepInfoResponse, ISCSWorkflowTemplateResponse, ISCSWorkflowTemplatesResponse

public interface ISCSServerResponse
extends ISCSServerBinder

A content server response

Nested Class Summary

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.util.List	getChangedSubjects()
java.util.List	getChangedTopics()
java.util.List	getFieldTypes()
java.lang.String	getMessage()
ISCSOptionList	getOptionList(java.lang.String name)
java.util.List	getOptionLists()
java.util.List	getRefreshSubjects()
java.lang.String	getUser()
boolean	isCachedResponse()

Methods inherited from interface com.stellent.cis.client.api.scs.ISCSServerBinder

addResultSet, addStream, clearStreams, deserializeBinderFromHDA, getChangeMonitors, getDateFormat, getQuerySubjects, getResultSet, getResultSet, getResultSetColumnNames, getResultSetNames, getResultSetSingleRow, getResultSetSingleRow, getService, getStream, getStreamNames, getTimeZoneFromDateFormat, serializeBinderAsHDA, setChangeMonitors, setQuerySubjects, setService

Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject

castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Method Detail

getUser

java.lang.String getUser()

Returns:

the user the executed this request

getFieldTypes

java.util.List getFieldTypes()

Returns:

a list of ISCSFieldType objects representing the field types available on this server response

getOptionLists

java.util.List getOptionLists()

Returns:

a list of ISCSOptionList objects

getOptionList

ISCSOptionList getOptionList(java.lang.String name)

Parameters:

name - the name of the option list

Returns:

the option list specified or null if no such option list is found

getMessage

java.lang.String getMessage()

Returns:

the message from the content server

isCachedResponse

boolean isCachedResponse()

Returns:

true if this response was generated from the filter cache, false otherwise

getChangedTopics

java.util.List getChangedTopics()

Returns:

a list of ISCSChangedMonitor representing the changed topics

getChangedSubjects

java.util.List getChangedSubjects()

Returns:

a list of ISCSChangedMonitor representing the changed subjects

getRefreshSubjects

java.util.List getRefreshSubjects()

Returns:

a list of ISCSChangedMonitor representing the refresh subjects