com.stellent.cis.client.api.scs.metadata
Interface ISCSMetadataAPI

All Superinterfaces:

ICommandAPI

public interface ISCSMetadataAPI
extends ICommandAPI

The command API implementation of the metadata commands. This implementation can be accessed directly via the ICommandFacade class, using the API name metadata, with the following syntax:

 ISCSMetadataAPI commandAPI =
       (ISCSMetadataAPI)m_commandFacade.getCommandAPI ("metadata", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

ISCSMetaDataEditResponse	editMetadata(ISCSContext SCSContext, ISCSDocMetaDefinition metaDefinition) Modifies an existing custom metadata field
ISCSMetaDataEditResponse	editMetadata(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocMetaDefinition metaDefinition) Modifies an existing custom metadata field
ICISAPIObjectFactory	getObjectFactory() Retrieve the object factory associated with this API

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()

Retrieve the object factory associated with this API

editMetadata

ISCSMetaDataEditResponse editMetadata(ISCSContext SCSContext,
                                      ISCSDocMetaDefinition metaDefinition)
                                      throws CommandException

Modifies an existing custom metadata field

Parameters:

SCSContext - the context object representing the current user

metaDefinition - The unique identifier for this custom Metadata field.

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_METADEF"

editMetadata

ISCSMetaDataEditResponse editMetadata(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext,
                                      ISCSDocMetaDefinition metaDefinition)
                                      throws CommandException

Modifies an existing custom metadata field

Parameters:

requestModifier - modify the request

SCSContext - the context object representing the current user

metaDefinition - The unique identifier for this custom Metadata field.

Throws:

CommandException

See Also:

"Content Server Documentation for: EDIT_METADEF"