oracle.ifs.admin.tools.script

Class DocumentAdmin

java.lang.Object

oracle.ifs.admin.tools.script.DocumentAdmin

public class DocumentAdmin
extends Object

The DocumentAdmin.java class - colleciton of Document admin tasks test.

Version:

1.0

Author:

Sirisha Ayyagari

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable	m_docTable
protected AdminManager	m_Main

Constructor Summary

Constructors

Constructor and Description
DocumentAdmin(AdminManager main) The only constructor that is being used.

Method Summary

Modifier and Type	Method and Description
void	checkinDocument(LibrarySession sess, ParameterTable params) Section variant of checkinDocument
void	checkinDocument(LibrarySession sess, String contentpath, String path) Inline/internal variant of checkinDocument
void	createDocument(LibrarySession sess, ParameterTable params) Section variant of Create Document
void	createDocument(LibrarySession sess, String idname, DocumentDefinition def) internal variant of Create Document
void	createDocument(LibrarySession sess, String idname, DocumentDefinition def, VersionDescriptionDefinition vddef) internal variant of VERSIONED Create Document
void	createDocument(LibrarySession sess, String idname, String nameToken) inline variant of Create Document
void	deleteDocument(LibrarySession sess, ParameterTable params) Section variant of delete Document
void	deleteDocument(LibrarySession sess, String idname) Inline/internal variant of Delete Document
void	deleteDocument(LibrarySession sess, String idname, LibraryObjectDefinition def) Inline/internal variant of Delete Document
void	freeDocument(LibrarySession sess, ParameterTable params) Section variant of Free Document
void	freeDocument(LibrarySession sess, String idname) Inline/internal variant of Free Document
void	getContentToFile(LibrarySession sess, ParameterTable params) Section variant of getContentToFile
void	getContentToFile(LibrarySession sess, String idname, String filename) internal variant of getContentToFile
void	identifyDocument(LibrarySession sess, ParameterTable params) Section variant of Identify Document
void	identifyDocument(LibrarySession sess, String idname, Long id, String name, String valueDefaultName, String path) Inline/internal variant of Identify Document
Document	lookupDocument(String idname)
void	modifyDocument(LibrarySession sess, ParameterTable params) Section variant of Modify Document
void	modifyDocument(LibrarySession sess, String idname, DocumentDefinition def) internal variant of Modify Document
void	reserveDocument(LibrarySession sess, ParameterTable params) Section variant of Reserve Document
void	reserveDocument(LibrarySession sess, String path) Inline/internal variant of Reserve Document
void	showDocument(LibrarySession sess, Document doc)
void	showDocument(LibrarySession sess, ParameterTable params) Section variant of showDocument
void	showDocument(LibrarySession sess, String docname) Inline/internal variant of showDocument
void	showDocumentReserveStatus(LibrarySession sess, ParameterTable params) Section variant of showDocumentReserveStatus
void	showDocumentReserveStatus(LibrarySession sess, String path) Inline/internal variant of showDocumentReserveStatus
void	showLatestVersion(LibrarySession sess, String path)
void	simpleFreeVersionedDocumentByPath(LibrarySession sess, ParameterTable params)
void	simpleGetVersionedDocument(LibrarySession sess, ParameterTable params) Section variant of GetVersioned Document
void	simpleGetVersionedDocument(LibrarySession sess, String docPath, String filename) Internal variant of getVersiondeDocument.
void	undeleteDocument(LibrarySession sess, ParameterTable params) Section variant of undelete Document
void	undeleteDocument(LibrarySession sess, String idname) Inline/internal variant of Undelete Document
void	undeleteDocument(LibrarySession sess, String idname, LibraryObjectDefinition def) Inline/internal variant of Undelete Document
void	unidentifyDocument(LibrarySession sess, ParameterTable params) Section variant of Unidentify Document
void	unreserveDocument(LibrarySession sess, ParameterTable params) Section variant of Unreserve Document
void	unreserveDocument(LibrarySession sess, String path) Inline/internal variant of Unreserve Document

Methods inherited from class java.lang.Object

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

Field Detail

m_Main

protected AdminManager m_Main

m_docTable

protected Hashtable m_docTable

Constructor Detail

DocumentAdmin

public DocumentAdmin(AdminManager main)

The only constructor that is being used.

Parameters:

main - Reference to AdminManager which invokes this.

Method Detail

createDocument

public void createDocument(LibrarySession sess,
                           ParameterTable params)
                    throws IfsException

Section variant of Create Document

Throws:

IfsException

createDocument

public void createDocument(LibrarySession sess,
                           String idname,
                           String nameToken)
                    throws IfsException

inline variant of Create Document

Throws:

IfsException

createDocument

public void createDocument(LibrarySession sess,
                           String idname,
                           DocumentDefinition def)
                    throws IfsException

internal variant of Create Document

Throws:

IfsException

createDocument

public void createDocument(LibrarySession sess,
                           String idname,
                           DocumentDefinition def,
                           VersionDescriptionDefinition vddef)
                    throws IfsException

internal variant of VERSIONED Create Document

Throws:

IfsException

modifyDocument

public void modifyDocument(LibrarySession sess,
                           ParameterTable params)
                    throws IfsException

Section variant of Modify Document

Throws:

IfsException

modifyDocument

public void modifyDocument(LibrarySession sess,
                           String idname,
                           DocumentDefinition def)
                    throws IfsException

internal variant of Modify Document

Throws:

IfsException

getContentToFile

public void getContentToFile(LibrarySession sess,
                             ParameterTable params)
                      throws IfsException

Section variant of getContentToFile

Throws:

IfsException

getContentToFile

public void getContentToFile(LibrarySession sess,
                             String idname,
                             String filename)
                      throws IfsException

internal variant of getContentToFile

Throws:

IfsException

freeDocument

public void freeDocument(LibrarySession sess,
                         ParameterTable params)
                  throws IfsException

Section variant of Free Document

Throws:

IfsException

freeDocument

public void freeDocument(LibrarySession sess,
                         String idname)
                  throws IfsException

Inline/internal variant of Free Document

Throws:

IfsException

deleteDocument

public void deleteDocument(LibrarySession sess,
                           ParameterTable params)
                    throws IfsException

Section variant of delete Document

Throws:

IfsException

deleteDocument

public void deleteDocument(LibrarySession sess,
                           String idname)
                    throws IfsException

Inline/internal variant of Delete Document

Throws:

IfsException

deleteDocument

public void deleteDocument(LibrarySession sess,
                           String idname,
                           LibraryObjectDefinition def)
                    throws IfsException

Inline/internal variant of Delete Document

Throws:

IfsException

undeleteDocument

public void undeleteDocument(LibrarySession sess,
                             ParameterTable params)
                      throws IfsException

Section variant of undelete Document

Throws:

IfsException

undeleteDocument

public void undeleteDocument(LibrarySession sess,
                             String idname)
                      throws IfsException

Inline/internal variant of Undelete Document

Throws:

IfsException

undeleteDocument

public void undeleteDocument(LibrarySession sess,
                             String idname,
                             LibraryObjectDefinition def)
                      throws IfsException

Inline/internal variant of Undelete Document

Throws:

IfsException

identifyDocument

public void identifyDocument(LibrarySession sess,
                             ParameterTable params)
                      throws IfsException

Section variant of Identify Document

Throws:

IfsException

identifyDocument

public void identifyDocument(LibrarySession sess,
                             String idname,
                             Long id,
                             String name,
                             String valueDefaultName,
                             String path)
                      throws IfsException

Inline/internal variant of Identify Document

Throws:

IfsException

unidentifyDocument

public void unidentifyDocument(LibrarySession sess,
                               ParameterTable params)
                        throws IfsException

Section variant of Unidentify Document

Throws:

IfsException

showDocument

public void showDocument(LibrarySession sess,
                         ParameterTable params)
                  throws IfsException

Section variant of showDocument

Throws:

IfsException

showDocument

public void showDocument(LibrarySession sess,
                         String docname)
                  throws IfsException

Inline/internal variant of showDocument

Throws:

IfsException

lookupDocument

public Document lookupDocument(String idname)
                        throws IfsException

Throws:

IfsException

showDocument

public void showDocument(LibrarySession sess,
                         Document doc)
                  throws IfsException

Throws:

IfsException

reserveDocument

public void reserveDocument(LibrarySession sess,
                            ParameterTable params)
                     throws IfsException

Section variant of Reserve Document

Throws:

IfsException

reserveDocument

public void reserveDocument(LibrarySession sess,
                            String path)
                     throws IfsException

Inline/internal variant of Reserve Document

Throws:

IfsException

simpleGetVersionedDocument

public void simpleGetVersionedDocument(LibrarySession sess,
                                       ParameterTable params)
                                throws IfsException

Section variant of GetVersioned Document

Throws:

IfsException

simpleGetVersionedDocument

public void simpleGetVersionedDocument(LibrarySession sess,
                                       String docPath,
                                       String filename)
                                throws IfsException

Internal variant of getVersiondeDocument.

Throws:

IfsException

unreserveDocument

public void unreserveDocument(LibrarySession sess,
                              ParameterTable params)
                       throws IfsException

Section variant of Unreserve Document

Throws:

IfsException

unreserveDocument

public void unreserveDocument(LibrarySession sess,
                              String path)
                       throws IfsException

Inline/internal variant of Unreserve Document

Throws:

IfsException

showDocumentReserveStatus

public void showDocumentReserveStatus(LibrarySession sess,
                                      ParameterTable params)
                               throws IfsException

Section variant of showDocumentReserveStatus

Throws:

IfsException

showDocumentReserveStatus

public void showDocumentReserveStatus(LibrarySession sess,
                                      String path)
                               throws IfsException

Inline/internal variant of showDocumentReserveStatus

Throws:

IfsException

checkinDocument

public void checkinDocument(LibrarySession sess,
                            ParameterTable params)
                     throws IfsException

Section variant of checkinDocument

Throws:

IfsException

checkinDocument

public void checkinDocument(LibrarySession sess,
                            String contentpath,
                            String path)
                     throws IfsException

Inline/internal variant of checkinDocument

Throws:

IfsException

showLatestVersion

public void showLatestVersion(LibrarySession sess,
                              String path)
                       throws IfsException

Throws:

IfsException

simpleFreeVersionedDocumentByPath

public void simpleFreeVersionedDocumentByPath(LibrarySession sess,
                                              ParameterTable params)
                                       throws IfsException

Throws:

IfsException