Skip navigation links

Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference
11g Release 1 (11.1)

E17350-01


com.stellent.cis.client.api.scs.document.checkin
Interface ISCSDocumentCheckinAPI

All Superinterfaces:
ICommandAPI

public interface ISCSDocumentCheckinAPI
extends ICommandAPI

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

 ISCSDocumentCheckinAPI commandAPI =
       (ISCSDocumentCheckinAPI)m_commandFacade.getCommandAPI ("document.checkin", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary
static java.lang.String API_CATEGORY
          Category for this Command API

 

Method Summary
 ISCSCheckinFlags _createCheckinFlags()
          Create a new checkin flags object.
 ISCSContent _createContent()
          Create a new empty content object.
 ISCSContent _createContent(java.lang.String contentID)
          Create a new empty content object with the given content ID.
 ISCSContent _createContent(java.lang.String contentID, java.lang.String documentID)
          Create a new empty content object with the given content ID and document ID.
 ISCSDocumentCheckinResponse checkinFile(ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile)
          Executes a checkin command agains the content server.
 ISCSDocumentCheckinResponse checkinFile(ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, ISCSCheckinFlags checkinFlags)
          Executes a checkin command agains the content server.
 ISCSDocumentCheckinResponse checkinFile(ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, java.lang.String alternateFile)
          Executes a checkin command agains the content server.
 ISCSDocumentCheckinResponse checkinFile(ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, java.lang.String alternateFile, ISCSCheckinFlags checkinFlags)
          Executes a checkin command agains the content server.
 ISCSDocumentCheckinResponse checkinFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile)
          Executes a checkin command agains the content server.
 ISCSDocumentCheckinResponse checkinFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, ISCSCheckinFlags checkinFlags)
          Executes a checkin command agains the content server.
 ISCSDocumentCheckinResponse checkinFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, java.lang.String alternateFile)
          Executes a checkin command agains the content server.
 ISCSDocumentCheckinResponse checkinFile(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, java.lang.String alternateFile, ISCSCheckinFlags checkinFlags)
          Executes a checkin command agains the content server.
 ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream)
          Checkin in a file by directly passing the file stream(s).
 ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream)
          Checkin in a file by directly passing the file stream(s).
 ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream, ISCSCheckinFlags checkinFlags)
          Checkin in a file by directly passing the file stream(s).
 ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ISCSCheckinFlags checkinFlags)
          Checkin in a file by directly passing the file stream(s).
 ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream)
          Checkin in a file by directly passing the file stream(s).
 ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream)
          Checkin in a file by directly passing the file stream(s).
 ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream, ISCSCheckinFlags checkinFlags)
          Checkin in a file by directly passing the file stream(s).
 ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ISCSCheckinFlags checkinFlags)
          Checkin in a file by directly passing the file stream(s).
 ISCSDocumentCheckinResponse checkinRevision(ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile)
          Checks a content item revision into the system.
 ISCSDocumentCheckinResponse checkinRevision(ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, ISCSCheckinFlags checkinFlags)
          Checks a content item revision into the system.
 ISCSDocumentCheckinResponse checkinRevision(ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, java.lang.String alternateFile)
          Checks a content item revision into the system.
 ISCSDocumentCheckinResponse checkinRevision(ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, java.lang.String alternateFile, ISCSCheckinFlags checkinFlags)
          Checks a content item revision into the system.
 ISCSDocumentCheckinResponse checkinRevision(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile)
          Checks a content item revision into the system.
 ISCSDocumentCheckinResponse checkinRevision(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, ISCSCheckinFlags checkinFlags)
          Checks a content item revision into the system.
 ISCSDocumentCheckinResponse checkinRevision(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, java.lang.String alternateFile)
          Checks a content item revision into the system.
 ISCSDocumentCheckinResponse checkinRevision(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, java.lang.String primaryFile, java.lang.String alternateFile, ISCSCheckinFlags checkinFlags)
          Checks a content item revision into the system.
 ISCSDocumentCheckinResponse checkinRevisionStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream)
          Checkin a new revision using an ICISTransferStream stream.
 ISCSDocumentCheckinResponse checkinRevisionStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream)
          Checkin a new revision using an ICISTransferStream stream.
 ISCSDocumentCheckinResponse checkinRevisionStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream, ISCSCheckinFlags checkinFlags)
          Checkin a new revision using an ICISTransferStream stream.
 ISCSDocumentCheckinResponse checkinRevisionStream(ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ISCSCheckinFlags checkinFlags)
          Checkin a new revision using an ICISTransferStream stream.
 ISCSDocumentCheckinResponse checkinRevisionStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream)
          Checkin a new revision using an ICISTransferStream stream.
 ISCSDocumentCheckinResponse checkinRevisionStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream)
          Checkin a new revision using an ICISTransferStream stream.
 ISCSDocumentCheckinResponse checkinRevisionStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ICISTransferStream alternateInputStream, ISCSCheckinFlags checkinFlags)
          Checkin a new revision using an ICISTransferStream stream.
 ISCSDocumentCheckinResponse checkinRevisionStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSContent content, ICISTransferStream primaryInputStream, ISCSCheckinFlags checkinFlags)
          Checkin a new revision using an ICISTransferStream stream.
 ISCSCheckinSimilarInfoResponse checkinSimilarInfo(ISCSContext SCSContext, ISCSDocumentID documentID)
          Gets information for building a contribution form with similar metaddata to another piece of content.
 ISCSCheckinSimilarInfoResponse checkinSimilarInfo(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID)
          Gets information for building a contribution form with similar metaddata to another piece of content.
 ISCSCheckinInfoResponse getCheckinInfo(ISCSContext SCSContext, ISCSDocumentID documentID)
          Gets information for building a contribution form with similar metaddata to another piece of content.
 ISCSCheckinInfoResponse getCheckinInfo(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSDocumentID documentID)
          Gets information for building a contribution form with similar metaddata to another piece of content.
 ICISAPIObjectFactory getObjectFactory()
          Retrieve the object factory associated with this API
 ISCSCheckinValidateResponse validateCheckin(ISCSContext SCSContext)
          Validate a user has rights to perform a checkin to the content server.
 ISCSCheckinValidateResponse validateCheckin(ISCSRequestModifier requestModifier, ISCSContext SCSContext)
          Validate a user has rights to perform a checkin to the content server.

 

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

checkinFile

ISCSDocumentCheckinResponse checkinFile(ISCSContext SCSContext,
                                        ISCSContent content,
                                        java.lang.String primaryFile)
                                        throws CommandException
Executes a checkin command agains the content server.
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFile

ISCSDocumentCheckinResponse checkinFile(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSContent content,
                                        java.lang.String primaryFile)
                                        throws CommandException
Executes a checkin command agains the content server.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFile

ISCSDocumentCheckinResponse checkinFile(ISCSContext SCSContext,
                                        ISCSContent content,
                                        java.lang.String primaryFile,
                                        ISCSCheckinFlags checkinFlags)
                                        throws CommandException
Executes a checkin command agains the content server.
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
checkinFlags - flags the modify the checkin process
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFile

ISCSDocumentCheckinResponse checkinFile(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSContent content,
                                        java.lang.String primaryFile,
                                        ISCSCheckinFlags checkinFlags)
                                        throws CommandException
Executes a checkin command agains the content server.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
checkinFlags - flags the modify the checkin process
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFile

ISCSDocumentCheckinResponse checkinFile(ISCSContext SCSContext,
                                        ISCSContent content,
                                        java.lang.String primaryFile,
                                        java.lang.String alternateFile)
                                        throws CommandException
Executes a checkin command agains the content server.
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
alternateFile - the path to the file
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFile

ISCSDocumentCheckinResponse checkinFile(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSContent content,
                                        java.lang.String primaryFile,
                                        java.lang.String alternateFile)
                                        throws CommandException
Executes a checkin command agains the content server.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
alternateFile - the path to the file
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFile

ISCSDocumentCheckinResponse checkinFile(ISCSContext SCSContext,
                                        ISCSContent content,
                                        java.lang.String primaryFile,
                                        java.lang.String alternateFile,
                                        ISCSCheckinFlags checkinFlags)
                                        throws CommandException
Executes a checkin command agains the content server.
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
alternateFile - the path to the file
checkinFlags - flags the modify the checkin process
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFile

ISCSDocumentCheckinResponse checkinFile(ISCSRequestModifier requestModifier,
                                        ISCSContext SCSContext,
                                        ISCSContent content,
                                        java.lang.String primaryFile,
                                        java.lang.String alternateFile,
                                        ISCSCheckinFlags checkinFlags)
                                        throws CommandException
Executes a checkin command agains the content server.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
alternateFile - the path to the file
checkinFlags - flags the modify the checkin process
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinRevision

ISCSDocumentCheckinResponse checkinRevision(ISCSContext SCSContext,
                                            ISCSContent content,
                                            java.lang.String primaryFile)
                                            throws CommandException
Checks a content item revision into the system.
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevision

ISCSDocumentCheckinResponse checkinRevision(ISCSRequestModifier requestModifier,
                                            ISCSContext SCSContext,
                                            ISCSContent content,
                                            java.lang.String primaryFile)
                                            throws CommandException
Checks a content item revision into the system.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevision

ISCSDocumentCheckinResponse checkinRevision(ISCSContext SCSContext,
                                            ISCSContent content,
                                            java.lang.String primaryFile,
                                            ISCSCheckinFlags checkinFlags)
                                            throws CommandException
Checks a content item revision into the system.
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
checkinFlags - flags the modify the checkin process
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevision

ISCSDocumentCheckinResponse checkinRevision(ISCSRequestModifier requestModifier,
                                            ISCSContext SCSContext,
                                            ISCSContent content,
                                            java.lang.String primaryFile,
                                            ISCSCheckinFlags checkinFlags)
                                            throws CommandException
Checks a content item revision into the system.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
checkinFlags - flags the modify the checkin process
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevision

ISCSDocumentCheckinResponse checkinRevision(ISCSContext SCSContext,
                                            ISCSContent content,
                                            java.lang.String primaryFile,
                                            java.lang.String alternateFile)
                                            throws CommandException
Checks a content item revision into the system.
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
alternateFile - the path to the file
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevision

ISCSDocumentCheckinResponse checkinRevision(ISCSRequestModifier requestModifier,
                                            ISCSContext SCSContext,
                                            ISCSContent content,
                                            java.lang.String primaryFile,
                                            java.lang.String alternateFile)
                                            throws CommandException
Checks a content item revision into the system.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
alternateFile - the path to the file
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevision

ISCSDocumentCheckinResponse checkinRevision(ISCSContext SCSContext,
                                            ISCSContent content,
                                            java.lang.String primaryFile,
                                            java.lang.String alternateFile,
                                            ISCSCheckinFlags checkinFlags)
                                            throws CommandException
Checks a content item revision into the system.
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
alternateFile - the path to the file
checkinFlags - flags the modify the checkin process
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevision

ISCSDocumentCheckinResponse checkinRevision(ISCSRequestModifier requestModifier,
                                            ISCSContext SCSContext,
                                            ISCSContent content,
                                            java.lang.String primaryFile,
                                            java.lang.String alternateFile,
                                            ISCSCheckinFlags checkinFlags)
                                            throws CommandException
Checks a content item revision into the system.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryFile - the path to the file
alternateFile - the path to the file
checkinFlags - flags the modify the checkin process
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevisionStream

ISCSDocumentCheckinResponse checkinRevisionStream(ISCSContext SCSContext,
                                                  ISCSContent content,
                                                  ICISTransferStream primaryInputStream)
                                                  throws CommandException
Checkin a new revision using an ICISTransferStream stream.
Parameters:
SCSContext - the context object representing the current user
content - the content item to checkin into the system
primaryInputStream - the inputstream of the primary file to be checked in
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevisionStream

ISCSDocumentCheckinResponse checkinRevisionStream(ISCSRequestModifier requestModifier,
                                                  ISCSContext SCSContext,
                                                  ISCSContent content,
                                                  ICISTransferStream primaryInputStream)
                                                  throws CommandException
Checkin a new revision using an ICISTransferStream stream.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the content item to checkin into the system
primaryInputStream - the inputstream of the primary file to be checked in
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevisionStream

ISCSDocumentCheckinResponse checkinRevisionStream(ISCSContext SCSContext,
                                                  ISCSContent content,
                                                  ICISTransferStream primaryInputStream,
                                                  ISCSCheckinFlags checkinFlags)
                                                  throws CommandException
Checkin a new revision using an ICISTransferStream stream.
Parameters:
SCSContext - the context object representing the current user
content - the content item to checkin into the system
primaryInputStream - the inputstream of the primary file to be checked in
checkinFlags - optional checkin properties
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevisionStream

ISCSDocumentCheckinResponse checkinRevisionStream(ISCSRequestModifier requestModifier,
                                                  ISCSContext SCSContext,
                                                  ISCSContent content,
                                                  ICISTransferStream primaryInputStream,
                                                  ISCSCheckinFlags checkinFlags)
                                                  throws CommandException
Checkin a new revision using an ICISTransferStream stream.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the content item to checkin into the system
primaryInputStream - the inputstream of the primary file to be checked in
checkinFlags - optional checkin properties
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevisionStream

ISCSDocumentCheckinResponse checkinRevisionStream(ISCSContext SCSContext,
                                                  ISCSContent content,
                                                  ICISTransferStream primaryInputStream,
                                                  ICISTransferStream alternateInputStream)
                                                  throws CommandException
Checkin a new revision using an ICISTransferStream stream.
Parameters:
SCSContext - the context object representing the current user
content - the content item to checkin into the system
primaryInputStream - the inputstream of the primary file to be checked in
alternateInputStream - the inputstream of the alternate file to be checkin in
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevisionStream

ISCSDocumentCheckinResponse checkinRevisionStream(ISCSRequestModifier requestModifier,
                                                  ISCSContext SCSContext,
                                                  ISCSContent content,
                                                  ICISTransferStream primaryInputStream,
                                                  ICISTransferStream alternateInputStream)
                                                  throws CommandException
Checkin a new revision using an ICISTransferStream stream.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the content item to checkin into the system
primaryInputStream - the inputstream of the primary file to be checked in
alternateInputStream - the inputstream of the alternate file to be checkin in
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevisionStream

ISCSDocumentCheckinResponse checkinRevisionStream(ISCSContext SCSContext,
                                                  ISCSContent content,
                                                  ICISTransferStream primaryInputStream,
                                                  ICISTransferStream alternateInputStream,
                                                  ISCSCheckinFlags checkinFlags)
                                                  throws CommandException
Checkin a new revision using an ICISTransferStream stream.
Parameters:
SCSContext - the context object representing the current user
content - the content item to checkin into the system
primaryInputStream - the inputstream of the primary file to be checked in
alternateInputStream - the inputstream of the alternate file to be checkin in
checkinFlags - optional checkin properties
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinRevisionStream

ISCSDocumentCheckinResponse checkinRevisionStream(ISCSRequestModifier requestModifier,
                                                  ISCSContext SCSContext,
                                                  ISCSContent content,
                                                  ICISTransferStream primaryInputStream,
                                                  ICISTransferStream alternateInputStream,
                                                  ISCSCheckinFlags checkinFlags)
                                                  throws CommandException
Checkin a new revision using an ICISTransferStream stream.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the content item to checkin into the system
primaryInputStream - the inputstream of the primary file to be checked in
alternateInputStream - the inputstream of the alternate file to be checkin in
checkinFlags - optional checkin properties
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL"

checkinSimilarInfo

ISCSCheckinSimilarInfoResponse checkinSimilarInfo(ISCSContext SCSContext,
                                                  ISCSDocumentID documentID)
                                                  throws CommandException
Gets information for building a contribution form with similar metaddata to another piece of content.
Parameters:
SCSContext - the context object representing the current user
documentID - the active document ID
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SIMILAR_FORM"

checkinSimilarInfo

ISCSCheckinSimilarInfoResponse checkinSimilarInfo(ISCSRequestModifier requestModifier,
                                                  ISCSContext SCSContext,
                                                  ISCSDocumentID documentID)
                                                  throws CommandException
Gets information for building a contribution form with similar metaddata to another piece of content.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
documentID - the active document ID
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SIMILAR_FORM"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream)
                                              throws CommandException
Checkin in a file by directly passing the file stream(s).
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryInputStream - the inputstream of the primary file to be checked in
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream)
                                              throws CommandException
Checkin in a file by directly passing the file stream(s).
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryInputStream - the inputstream of the primary file to be checked in
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ISCSCheckinFlags checkinFlags)
                                              throws CommandException
Checkin in a file by directly passing the file stream(s).
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryInputStream - the inputstream of the primary file to be checked in
checkinFlags - flags that control the checkin operation
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ISCSCheckinFlags checkinFlags)
                                              throws CommandException
Checkin in a file by directly passing the file stream(s).
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryInputStream - the inputstream of the primary file to be checked in
checkinFlags - flags that control the checkin operation
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ICISTransferStream alternateInputStream)
                                              throws CommandException
Checkin in a file by directly passing the file stream(s).
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryInputStream - the inputstream of the primary file to be checked in
alternateInputStream - the inputstream of the alternate file to be checkin in
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ICISTransferStream alternateInputStream)
                                              throws CommandException
Checkin in a file by directly passing the file stream(s).
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryInputStream - the inputstream of the primary file to be checked in
alternateInputStream - the inputstream of the alternate file to be checkin in
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ICISTransferStream alternateInputStream,
                                              ISCSCheckinFlags checkinFlags)
                                              throws CommandException
Checkin in a file by directly passing the file stream(s).
Parameters:
SCSContext - the context object representing the current user
content - the document node
primaryInputStream - the inputstream of the primary file to be checked in
alternateInputStream - the inputstream of the alternate file to be checkin in
checkinFlags - flags that control the checkin operation
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

checkinFileStream

ISCSDocumentCheckinResponse checkinFileStream(ISCSRequestModifier requestModifier,
                                              ISCSContext SCSContext,
                                              ISCSContent content,
                                              ICISTransferStream primaryInputStream,
                                              ICISTransferStream alternateInputStream,
                                              ISCSCheckinFlags checkinFlags)
                                              throws CommandException
Checkin in a file by directly passing the file stream(s).
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
content - the document node
primaryInputStream - the inputstream of the primary file to be checked in
alternateInputStream - the inputstream of the alternate file to be checkin in
checkinFlags - flags that control the checkin operation
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_UNIVERSAL"

getCheckinInfo

ISCSCheckinInfoResponse getCheckinInfo(ISCSContext SCSContext,
                                       ISCSDocumentID documentID)
                                       throws CommandException
Gets information for building a contribution form with similar metaddata to another piece of content.
Parameters:
SCSContext - the context object representing the current user
documentID - active document ID of the item to match metadata
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL_FORM"

getCheckinInfo

ISCSCheckinInfoResponse getCheckinInfo(ISCSRequestModifier requestModifier,
                                       ISCSContext SCSContext,
                                       ISCSDocumentID documentID)
                                       throws CommandException
Gets information for building a contribution form with similar metaddata to another piece of content.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
documentID - active document ID of the item to match metadata
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_SEL_FORM"

validateCheckin

ISCSCheckinValidateResponse validateCheckin(ISCSContext SCSContext)
                                            throws CommandException
Validate a user has rights to perform a checkin to the content server.
Parameters:
SCSContext - the context object representing the current user
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_NEW_FORM"

validateCheckin

ISCSCheckinValidateResponse validateCheckin(ISCSRequestModifier requestModifier,
                                            ISCSContext SCSContext)
                                            throws CommandException
Validate a user has rights to perform a checkin to the content server.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
Throws:
CommandException
See Also:
"Content Server Documentation for: CHECKIN_NEW_FORM"

_createContent

ISCSContent _createContent()
Create a new empty content object.
Returns:
a new empty content object

_createContent

ISCSContent _createContent(java.lang.String contentID)
Create a new empty content object with the given content ID.
Parameters:
contentID - the content ID of the item
Returns:
a new empty content object

_createContent

ISCSContent _createContent(java.lang.String contentID,
                           java.lang.String documentID)
Create a new empty content object with the given content ID and document ID.
Parameters:
contentID - the content ID of the item
documentID - the document ID of the item
Returns:
a new empty content object

_createCheckinFlags

ISCSCheckinFlags _createCheckinFlags()
Create a new checkin flags object.
Returns:
a new checkin flags object

Skip navigation links

Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference
11g Release 1 (11.1)

E17350-01


Copyright © 1996, 2010, Oracle and/or its affiliates. All rights reserved.