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

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSObject, 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, ISCSServerResponse, 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 ISCSServerBinder
extends ISCSObject

Represents a wrapping of the base Content Server binder object.

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

void	addResultSet(java.lang.String name, java.util.List resultSet) Add the result set to this binder
void	addStream(java.lang.String name, ICISTransferStream transferStream) Add the stream to the binder object.
void	clearStreams() Remove all the streams from the server binder
void	deserializeBinderFromHDA(java.io.Reader reader) Deserialize the Content Server hda binder representation from the given reader and merge the results into this binder object.
java.util.List	getChangeMonitors(java.lang.String name) Retrieve a list of changed monitors by name
java.lang.String	getDateFormat()
java.util.List	getQuerySubjects()
java.util.List	getResultSet(java.lang.String name)
java.util.List	getResultSet(java.lang.String name, java.lang.Class type) Retrieve a result set and convert all the members of the result set to the given type.
java.util.List	getResultSetColumnNames(java.lang.String name) Retreive a list of the column names in order for the given result set
java.util.Collection	getResultSetNames()
ISCSObject	getResultSetSingleRow(java.lang.String name) Retrieve the first row of the result set specified.
ISCSObject	getResultSetSingleRow(java.lang.String name, java.lang.Class type) Retrieve the first row of the result set specified and convert it to the given type.
java.lang.String	getService()
ICISTransferStream	getStream(java.lang.String name) Retrieve a stream that was added to the databinder
java.util.List	getStreamNames() Retrieve the list of stream names in the databinder
java.lang.String	getTimeZoneFromDateFormat()
void	serializeBinderAsHDA(java.io.Writer writer) Serialize the binder to Content Server hda format
void	setChangeMonitors(java.lang.String name, java.util.List monitors) Add a list of change monitors to the ISCSServerBinder (monitoredSubjects, etc.)
void	setQuerySubjects(java.util.List querySubjects) Set some query subjects for this binder
void	setService(java.lang.String service) Set the IDC service to execute

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

setQuerySubjects

void setQuerySubjects(java.util.List querySubjects)

Set some query subjects for this binder

Parameters:

querySubjects - a changed monitor list of the query subjects

getQuerySubjects

java.util.List getQuerySubjects()

Returns:

a changed monitor list of the query subjects

setChangeMonitors

void setChangeMonitors(java.lang.String name,
                       java.util.List monitors)

Add a list of change monitors to the ISCSServerBinder (monitoredSubjects, etc.)

Parameters:

name - the monitor name

monitors - a list of ISCSChangedMonitor objects

getChangeMonitors

java.util.List getChangeMonitors(java.lang.String name)

Retrieve a list of changed monitors by name

Parameters:

name - the monitor name

Returns:

a list of ISCSChangedMonitor objects

getService

java.lang.String getService()

Returns:

the IDC Service that was executed on the content server

setService

void setService(java.lang.String service)

Set the IDC service to execute

Parameters:

service - the service name

getDateFormat

java.lang.String getDateFormat()

Returns:

the string that contains the date format

getResultSet

java.util.List getResultSet(java.lang.String name)

Parameters:

name - the native name of the result set

Returns:

a list of ISCSObject representing each object in the result set

getResultSetSingleRow

ISCSObject getResultSetSingleRow(java.lang.String name)

Retrieve the first row of the result set specified. The equivalent of calling getResultSet(name).get(0).

Parameters:

name - the result set name

Returns:

the first row in the result set as the give type

getResultSetSingleRow

ISCSObject getResultSetSingleRow(java.lang.String name,
                                 java.lang.Class type)

Retrieve the first row of the result set specified and convert it to the given type. The equivalent of calling getResultSet(name, type).get(0).

Parameters:

name - the result set name

type - the type to create for the result row

Returns:

the first row in the result set as the give type

getResultSet

java.util.List getResultSet(java.lang.String name,
                            java.lang.Class type)

Retrieve a result set and convert all the members of the result set to the given type.

Parameters:

name - the name of the result set

type - the type of objects to use in the result set

Returns:

the list of items or null if not found

getResultSetNames

java.util.Collection getResultSetNames()

Returns:

a collection of names of the available result sets

getResultSetColumnNames

java.util.List getResultSetColumnNames(java.lang.String name)

Retreive a list of the column names in order for the given result set

Parameters:

name - the name of the result set

Returns:

The column names as a list of String objects

addResultSet

void addResultSet(java.lang.String name,
                  java.util.List resultSet)

Add the result set to this binder

Parameters:

name - the name of the result set

resultSet - a homogenous list of ISCSObjects

addStream

void addStream(java.lang.String name,
               ICISTransferStream transferStream)
               throws java.io.IOException

Add the stream to the binder object. These streams will be sent as parameters to the content server.

Parameters:

name - the key to store the stream

transferStream - the stream object

Throws:

java.io.IOException

clearStreams

void clearStreams()

Remove all the streams from the server binder

getStream

ICISTransferStream getStream(java.lang.String name)

Retrieve a stream that was added to the databinder

Parameters:

name - the name the stream was stored under

Returns:

the stream object

getTimeZoneFromDateFormat

java.lang.String getTimeZoneFromDateFormat()

Returns:

the timezone as determined by examining the getDateFormat(), might return null if the timezone cannot be determined

serializeBinderAsHDA

void serializeBinderAsHDA(java.io.Writer writer)
                          throws java.io.IOException

Serialize the binder to Content Server hda format

Parameters:

writer - the writer to send the serialized output

Throws:

java.io.IOException

deserializeBinderFromHDA

void deserializeBinderFromHDA(java.io.Reader reader)
                              throws java.io.IOException

Deserialize the Content Server hda binder representation from the given reader and merge the results into this binder object.

Parameters:

reader - the reader containing the hda representation of the binder

Throws:

java.io.IOException

getStreamNames

java.util.List getStreamNames()

Retrieve the list of stream names in the databinder

Returns:

List of stream names or null