oracle.ifs.protocols.commands

Class IfsCreateDocumentContext

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommandContext

oracle.ifs.protocols.commands.IfsCreateDocumentContext

All Implemented Interfaces:

CreateDocumentContext, CommandContext

public class IfsCreateDocumentContext
extends IfsCommandContext
implements CreateDocumentContext

IfsCreateDocumentContext is the default implmentation of CreateDocumentContext.

Version:

0.9

Author:

Patricia Li

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
IfsCreateDocumentContext() Deafult Constructor.
IfsCreateDocumentContext(LibrarySession session, String name, InputStream stream, Folder folder, AccessControlList acl) Constructor which sets up all the required parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the Context.
AccessControlList	getAcl() Gets the ACL.
InputStream	getContentStream() Gets the content stream.
Document	getDocument() Gets the returning document.
Folder	getFolder() Gets the folder.
LibrarySession	getLibrarySession() Gets the session.
String	getName() Gets the document name.
void	setAcl(AccessControlList acl) Sets the ACL.
void	setContentStream(InputStream stream) Sets the content stream.
void	setDocument(Document doc) Sets the returning document.
void	setFolder(Folder folder) Sets the folder.
void	setLibrarySession(LibrarySession session) Sets the session.
void	setName(String name) Sets the document name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IfsCreateDocumentContext

public IfsCreateDocumentContext()
                         throws IfsException

Deafult Constructor.

Throws:

IfsException

(Published)

IfsCreateDocumentContext

public IfsCreateDocumentContext(LibrarySession session,
                                String name,
                                InputStream stream,
                                Folder folder,
                                AccessControlList acl)
                         throws IfsException

Constructor which sets up all the required parameters.

Parameters:

session - LibrarySession.

name - Document name.

stream - Content stream.

folder - Parent folder into which to create the document.

acl - ACL to be applied to the new document.

Throws:

IfsException - - If operation fails.

(Published)

Method Detail

clear

public void clear()

Clears the Context.

Specified by:

clear in interface CommandContext

Overrides:

clear in class IfsCommandContext

(Published)

getLibrarySession

public LibrarySession getLibrarySession()
                                 throws IfsException

Gets the session.

Specified by:

getLibrarySession in interface CreateDocumentContext

Throws:

IfsException

(Published)

setLibrarySession

public void setLibrarySession(LibrarySession session)
                       throws IfsException

Sets the session.

Specified by:

setLibrarySession in interface CreateDocumentContext

Throws:

IfsException

(Published)

getName

public String getName()
               throws IfsException

Gets the document name.

Specified by:

getName in interface CreateDocumentContext

Throws:

IfsException

(Published)

setName

public void setName(String name)
             throws IfsException

Sets the document name.

Specified by:

setName in interface CreateDocumentContext

Throws:

IfsException

(Published)

getContentStream

public InputStream getContentStream()
                             throws IfsException

Gets the content stream.

Specified by:

getContentStream in interface CreateDocumentContext

Throws:

IfsException

(Published)

setContentStream

public void setContentStream(InputStream stream)
                      throws IfsException

Sets the content stream.

Specified by:

setContentStream in interface CreateDocumentContext

Throws:

IfsException

(Published)

getFolder

public Folder getFolder()
                 throws IfsException

Gets the folder.

Specified by:

getFolder in interface CreateDocumentContext

Throws:

IfsException

(Published)

setFolder

public void setFolder(Folder folder)
               throws IfsException

Sets the folder.

Specified by:

setFolder in interface CreateDocumentContext

Throws:

IfsException

(Published)

getAcl

public AccessControlList getAcl()
                         throws IfsException

Gets the ACL.

Specified by:

getAcl in interface CreateDocumentContext

Throws:

IfsException

(Published)

setAcl

public void setAcl(AccessControlList acl)
            throws IfsException

Sets the ACL.

Specified by:

setAcl in interface CreateDocumentContext

Throws:

IfsException

(Published)

getDocument

public Document getDocument()
                     throws IfsException

Gets the returning document.

Specified by:

getDocument in interface CreateDocumentContext

Throws:

IfsException

(Published)

setDocument

public void setDocument(Document doc)
                 throws IfsException

Sets the returning document.

Specified by:

setDocument in interface CreateDocumentContext

Throws:

IfsException

(Published)