| Modifier and Type | Method and Description | 
|---|---|
Document | 
DocumentAdmin.lookupDocument(String idname)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
DocumentAdmin.showDocument(LibrarySession sess,
            Document doc)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
MessageEntry
A MessageEntry reflects a single message within a MessageList. 
 | 
class  | 
TieDocument
TieDocument allows the Oracle-defined behavior of the
 DOCUMENT classobject (and its subclasses) to be extended
 or overridden. 
 | 
class  | 
TieMessageEntry
TieMessageEntry allows the ECMSDK-defined behavior of the
 MessageEntry classobject (and its subclasses) to be extended
 or overridden. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected static Document | 
Document.constructDocument(LibrarySession sess,
                 S_LibraryObjectData data)
Constructs a Document object from the 
 S_LibraryObjectData object. 
 | 
Document | 
Folder.createSecuredDocument(DocumentDefinition def)
Create a document that is parented to and secured by the target folder. 
 | 
Document | 
AttachmentRelation.getAttachment()
Gets the related attached Document. 
 | 
Document | 
AttachmentRelationDefinition.getAttachment()
Gets the related attached Document, if explicitly set. 
 | 
Document[] | 
PublicObject.getAttachments()
Get the attached Documents. 
 | 
Document | 
PrintJob.getDocument()
Get the Document that contains the content of this PrintJob. 
 | 
protected static Document | 
Document.vectorDocumentElement(Vector vector,
                     int index)
Returns a Document element from the Vector of Document
 objects at the specified index. 
 | 
protected static Document[] | 
Document.vectorToDocumentArray(Vector vector)
Converts a Vector of Document to an array of
 DirectoryGroup. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
AttachmentRelation | 
PublicObject.addAttachment(Document doc)
Add an Attachment. 
 | 
void | 
InterMediaAnnotator.annotate(Document doc,
        boolean trimMetadata)
Performs annotation processing for the specified Document. 
 | 
void | 
LifecyclePolicy.applyLock(Document doc)
Apply a lock on the specified document, as it
 is in the process of referencing this LifecyclePolicy. 
 | 
void | 
RetentionPolicy.applyLock(Document doc)
Apply a record lock on the specified document, as it
 is in the process of referencing this RetentionPolicy. 
 | 
void | 
LifecyclePolicy.applyUnlock(Document doc)
Release the lock held on the specified document, as it
 is in the process of not referencing this LifecyclePolicy. 
 | 
void | 
RetentionPolicy.applyUnlock(Document doc)
Release the lock held on the specified document, as it
 is in the process of not referencing this RetentionPolicy. 
 | 
AttachmentRelation | 
PublicObject.findAttachmentRelation(Document doc)
Find an AttachmentRelation that corresponds to an attached Document. 
 | 
protected void | 
InterMediaAnnotator.freeInterMediaCategories(Document doc)
Frees any InterMedia categories that exist onthe specified document. 
 | 
RandomAccessor | 
ContentObject.getContentByRandomAccess(Document refObj)
Gets a RandomAccessor for randomly reading the content of this
 ContentObject. 
 | 
protected String | 
InterMediaAnnotator.getContentMimeType(Document doc)
Returns the mime type from the specified Document, if it has content. 
 | 
protected void | 
InterMediaAnnotator.implementAnnotate(Document doc,
                 boolean trimMetadata)
Internal annotation processing for the specified Document. 
 | 
boolean | 
PublicObject.isAttachment(Document doc)
Returns indication as to whether the specified Document is an attachment. 
 | 
void | 
InterMediaAnnotator.processDocument(Document doc)
Performs annotation processing for the specified Document. 
 | 
void | 
PublicObject.removeAttachment(Document doc)
Remove an Attachment. 
 | 
void | 
AttachmentRelationDefinition.setAttachment(Document doc)
Sets the related attached Document. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
LifecyclePolicyActionOutcome | 
FreeLifecyclePolicyAction.execute(LifecyclePolicyEntry lpe,
       Document doc)  | 
LifecyclePolicyActionOutcome | 
LifecyclePolicyAction.execute(LifecyclePolicyEntry lpe,
       Document doc)
Execute the action for the specified document. 
 | 
LifecyclePolicyActionOutcome | 
LifecyclePolicyActionAdapter.execute(LifecyclePolicyEntry lpe,
       Document doc)
Execute the action for the specified document. 
 | 
LifecyclePolicyActionOutcome | 
StorageChangeLifecyclePolicyAction.execute(LifecyclePolicyEntry lpe,
       Document doc)
Execute the action for the specified document. 
 | 
Date | 
LifecycleDateRule.getLifecycleDate(Document doc)
Determine the LifecycleDate for the specified document
 and the specified LifecyclePolicy. 
 | 
Date | 
LifecycleDateRuleAdapter.getLifecycleDate(Document doc)  | 
LifecyclePolicyActionOutcome | 
LifecyclePolicyAction.notify(LifecyclePolicyEntry lpe,
      Document doc)
Notify action that the specified document has advanced to the lifecycle
 state as indicated by the specified LifecyclePolicyEntry. 
 | 
LifecyclePolicyActionOutcome | 
LifecyclePolicyActionAdapter.notify(LifecyclePolicyEntry lpe,
      Document doc)
Notify action that the specified document has advanced to the lifecycle
 state as indicated by the specified LifecyclePolicyEntry. 
 | 
static void | 
LifecycleActionProcessor.processEventAction(LibrarySession session,
                  Document doc)
Process the event action for the specified Document and 
 LifecyclePolicyEntry. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Document | 
ClassSelectionParser.createDocument(Folder parent,
              DocumentDefinition def,
              String name,
              String classname,
              ParserCallback callback)
Deprecated.  
Encapsulates document creation given a parent folder, a name, Document subclass classname,
 and an stream/reader; 
 will not update a prior existing object in parent, 
 will throw an IfsException simply because an object already exists in parent with name 
 | 
Document | 
LiteralDocumentParser.createDocument(Folder parent,
              InputStream in,
              Reader reader,
              String name,
              AccessControlList acl,
              boolean takeAclFromParent)  | 
protected Document | 
ClassSelectionParser.updateFolderedPublicObjectWithVersioning(Folder parent,
                                        DocumentDefinition def,
                                        String name,
                                        String classname,
                                        ParserCallback callback)
Deprecated.  
encapsulates the item update given a parent folder, a name, and an stream/reader; 
 will update a prior existing object in parent, 
 will throw an IfsException simply because an object doesn't exist in parent 
 | 
Document | 
LiteralDocumentParser.updateFolderedPublicObjectWithVersioning(Folder parent,
                                        InputStream in,
                                        Reader reader,
                                        String name,
                                        AccessControlList acl,
                                        boolean takeAclFromParent)  | 
| Modifier and Type | Method and Description | 
|---|---|
List<Document> | 
MessageAction.getAttachementList()
Returns the list of attachments for ad and edit actions 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
MessageAction.addAttachment(Document doc)
Adds an attachment, prior to execution. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Document | 
InformationExtractionTrainerSpecification.createCoreNlpRegexRuleDocument(InformationExtractionDomainSpecification dspec,
                              InformationExtractionParserSpecification pspec,
                              String docName,
                              String docDesc,
                              AccessControlList docAcl,
                              Folder docFolder,
                              boolean addAsVersion)
Updates the CoreNLP REGEX Rules model by creating a new model Document. 
 | 
Document | 
InformationExtractionTrainerSpecification.createDependencyMatcherRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec,
                                            InformationExtractionParserSpecification pspec,
                                            String docName,
                                            String docDesc,
                                            AccessControlList docAcl,
                                            Folder docFolder,
                                            boolean addAsVersion)
Updates the JSON representation of the DependencyMatcher REGEX Rules 
 by creating a new Document. 
 | 
Document | 
InformationExtractionTrainerSpecification.createEntityRulerRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec,
                                      InformationExtractionParserSpecification pspec,
                                      String docName,
                                      String docDesc,
                                      AccessControlList docAcl,
                                      Folder docFolder,
                                      boolean addAsVersion)
Updates the JSON representation of the EntityRuler REGEX Rules 
 by creating a new Document. 
 | 
Document | 
InformationExtractionTrainerSpecification.createNerClassifierDocument(InformationExtractionParserSpecification pspec,
                           AttributeValueTable trainingProps,
                           String docName,
                           String docDesc,
                           AccessControlList docAcl,
                           Folder docFolder,
                           boolean addAsVersion)
Updates the NER Classifier model by creating a new NER Classifier Document. 
 | 
Document | 
InformationExtractionTrainingSet.createNerClassifierDocument(InformationExtractionParserSpecification pspec,
                           AttributeValueTable trainingProps,
                           String docName,
                           String docDesc,
                           AccessControlList docAcl,
                           Folder docFolder,
                           boolean addAsVersion)
Updates the NER Classifier model by creating a new NER Classifier Document. 
 | 
Document | 
InformationExtractionTrainerSpecification.createRegexPatternDocument(InformationExtractionDomainSpecification dspec,
                          InformationExtractionParserSpecification pspec,
                          String docName,
                          String docDesc,
                          AccessControlList docAcl,
                          Folder docFolder,
                          boolean addAsVersion)
Updates the REGEX Pattern model by creating a new model Document. 
 | 
Document | 
InformationExtractionTrainerSpecification.createRegexPatternJsonDocument(InformationExtractionDomainSpecification dspec,
                              InformationExtractionParserSpecification pspec,
                              String docName,
                              String docDesc,
                              AccessControlList docAcl,
                              Folder docFolder,
                              boolean addAsVersion)
Updates the JSON representation of the REGEX Patterns 
 by creating a new Document. 
 | 
Document | 
InformationExtractionTrainerSpecification.createRelationMentionModelDocument(InformationExtractionParserSpecification pspec,
                                  AttributeValueTable trainingProps,
                                  String docName,
                                  String docDesc,
                                  AccessControlList docAcl,
                                  Folder docFolder,
                                  boolean addAsVersion)
Updates the RelationMention model by creating a new model Document. 
 | 
Document | 
InformationExtractionTrainingSet.createRelationMentionModelDocument(InformationExtractionParserSpecification pspec,
                                  AttributeValueTable trainingProps,
                                  String docName,
                                  String docDesc,
                                  AccessControlList docAcl,
                                  Folder docFolder,
                                  boolean addAsVersion)
Updates the RelationMention model by creating a new model Document. 
 | 
Document | 
InformationExtractionTrainerSpecification.createSpacyClassifierDocument(InformationExtractionParserSpecification pspec,
                             AttributeValueTable trainingProps,
                             String docName,
                             String docDesc,
                             AccessControlList docAcl,
                             Folder docFolder,
                             boolean addAsVersion)
Updates the Spacy Classifier model by creating a new Spacy NER Classifier Document. 
 | 
Document | 
InformationExtractionTrainingSet.createSpacyClassifierDocument(InformationExtractionParserSpecification pspec,
                             AttributeValueTable trainingProps,
                             String docName,
                             String docDesc,
                             AccessControlList docAcl,
                             Folder docFolder,
                             boolean addAsVersion)
Updates the Spacy Classifier model by creating a new Spacy Classifier Document. 
 | 
protected Document | 
InformationExtractionTrainingSet.createSpacyClassifierTrainingDocument(Document classfierDoc,
                                     InformationExtraction ext)
Create a Spacy Classifier Document based on the specified classifier document. 
 | 
Document | 
InformationExtractionTrainerSpecification.createTokenMatcherRegexRuleJsonDocument(InformationExtractionDomainSpecification dspec,
                                       InformationExtractionParserSpecification pspec,
                                       String docName,
                                       String docDesc,
                                       AccessControlList docAcl,
                                       Folder docFolder,
                                       boolean addAsVersion)
Updates the JSON representation of the TokenMatcher REGEX Rules 
 by creating a new Document. 
 | 
Document[] | 
InformationExtractionTrainingSet.getClassifierDocuments()
Gets the Classifier Documents defined for this instance. 
 | 
Document[] | 
InformationExtractionTrainingSet.getRelationDocuments()
Gets the set of Relation Documents (from Confirmed Outcomes)
 in CONLL format to be used as training input. 
 | 
Document | 
InformationExtraction.getSourceDocument()
Gets the source document for this extraction. 
 | 
Document[] | 
InformationExtractionTrainingSet.getSpacyClassifierDocuments()
Gets the Spacy Classifier Documents defined for this instance. 
 | 
Document | 
InformationExtraction.getTokensDocument()
Gets the text document holding the tokens corresponding to the 
 Source Document of this extraction. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
InformationExtractionTrainingSet.addClassifierDocument(Document val)
Adds the specified classifier document to this training set. 
 | 
void | 
InformationExtractionTrainingSet.addClassifierDocument(Document doc,
                     InformationExtraction ext)
Adds the specified classifier document to this training set,
 on behalf of the optionally specified InformationExtraction. 
 | 
protected void | 
InformationExtractionTrainingSet.addClassifierResult(Document classfierDoc,
                   InformationExtraction ext)
Adds the specified classifier document as a result,
  and perform other processing, if indicated. 
 | 
void | 
InformationExtractionTrainingSet.addRelationDocument(Document val)
Adds the specified relation document to this training set. 
 | 
protected Document | 
InformationExtractionTrainingSet.createSpacyClassifierTrainingDocument(Document classfierDoc,
                                     InformationExtraction ext)
Create a Spacy Classifier Document based on the specified classifier document. 
 | 
protected String | 
InformationExtractionTrainingSet.determineSpacyClassifierTrainingContent(Document classifierDoc)
Determine the contents to use for the Spacy Classifier Training document. 
 | 
protected String | 
InformationExtractionTrainingSet.determineSpacyClassifierTrainingDocumentName(Document classifierDoc)
Determine the Name to use for the Spacy Classifier Training document. 
 | 
void | 
InformationExtractionTrainingSet.removeClassifierDocument(Document val)
Removes the specified classifier document from this training set. 
 | 
void | 
InformationExtractionTrainingSet.removeRelationDocument(Document val)
Removes the specified relation document from this training set. 
 | 
void | 
InformationExtractionTrainingSet.setClassifierDocument(Document val)
Sets the specified classifier document to this training set,
 replacing any previous training data. 
 | 
void | 
InformationExtractionTrainingSet.setClassifierDocument(Document doc,
                     InformationExtraction ext)
Sets the specified classifier document to this training set,
 replacing any previous training data,
 on behalf of the optionally specified InformationExtraction. 
 | 
void | 
InformationExtractionTrainingSet.setRelationDocument(Document val)
Sets the specified relation document to this training set,
 replacing any previous training data. 
 | 
void | 
InformationExtraction.setSourceDocument(Document val)
Sets the source document for this extraction. 
 | 
void | 
InformationExtraction.setTokensDocument(Document val)
Sets the text document holding the tokens corresponding 
 to the Source Document of this extracton. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Document | 
BasicInformationExtractionTrainer.addClassifierTrainingDocument(InformationExtraction ext,
                             InformationExtractionOutcome confOutcome,
                             InformationExtractionTrainingSet tset)
Add a Classifier Document based on the confirmed outcome. 
 | 
protected Document | 
BasicInformationExtractionTrainer.addConllRelationTrainingDocument(InformationExtraction ext,
                                InformationExtractionOutcome confOutcome,
                                InformationExtractionTrainingSet tset)
Add a CONLL Relation training Document based on the confirmed outcome. 
 | 
protected Document | 
BasicInformationExtractionTrainer.addSpacyClassifierTrainingDocument(InformationExtraction ext,
                                  InformationExtractionOutcome confOutcome,
                                  InformationExtractionTrainingSet tset,
                                  Document classfierDoc)
Add a Spacy Classifier Document based on the confirmed outcome. 
 | 
Document | 
SpacyClassifierModelCreator.create(InformationExtractionTrainingSet tset,
      InformationExtractionParserSpecification pspec,
      AttributeValueTable trainingProps,
      String docName,
      String docDesc,
      AccessControlList docAcl,
      Folder docFolder)
Create a new Spacy Classifier model, stored as a Document,
 based on the specified training set. 
 | 
protected Document | 
PythonParser.createJsonResultDocument(String jsonFile)
Create the JSON result document that contains the raw NLP information
 generated in spaCy. 
 | 
protected Document | 
BasicInformationExtractionPreparer.createTokensDocument(InformationExtraction ext)
Create a tokens Document. 
 | 
protected Document | 
PythonParser.getDocument(AttributeValue av,
           LibrarySession session)
Gets a Document object from the specified AttributeValue,
 which can reference a Document, Family, or VersionSeries. 
 | 
protected Document | 
SpacyClassifierModelCreator.getDocument(AttributeValue av,
           LibrarySession session)
Gets a Document object from the specified AttributeValue,
 which can reference a Document, Family, or VersionSeries. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Document | 
BasicInformationExtractionTrainer.addSpacyClassifierTrainingDocument(InformationExtraction ext,
                                  InformationExtractionOutcome confOutcome,
                                  InformationExtractionTrainingSet tset,
                                  Document classfierDoc)
Add a Spacy Classifier Document based on the confirmed outcome. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Document | 
ScriptOperations.lookupDocument(LibrarySession sess,
              String tag)
Lookup a Document by the specified tag. 
 | 
protected Document[] | 
ScriptOperations.tokenToDocumentArray(LibrarySession sess,
                    String token)
Get an array of Documents from the specified array token containing
 Document tags. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
ShowUtils.showDocument(Logger logger,
            Document doc,
            String prefix)
Show details about a document. 
 | 
static void | 
ShowUtils.showDocumentContentInfo(Logger logger,
                       Document doc,
                       String prefix)
Show details about a document's content. 
 | 
protected void | 
ScriptOperations.showDocumentContents(Document doc,
                    String prefix)
Show a Document's content, using its Reader. 
 | 
protected void | 
ScriptOperations.showDocumentContents(Document doc,
                    String prefix,
                    boolean replaceNums)
Show a Document's content, using its Reader, and optionally
 replacing all numbers with an X (for test output). 
 | 
static void | 
ShowUtils.showDocumentWithLifecycleInfo(Logger logger,
                             Document doc,
                             boolean showDates,
                             String prefix)
Show lifecycle details about a document. 
 | 
| Modifier and Type | Field and Description | 
|---|---|
protected Document | 
VersioningOperations.RelationTest.m_DocumentSource  | 
protected Document | 
VersioningOperations.RelationTest.m_DocumentTarget  | 
| Modifier and Type | Method and Description | 
|---|---|
Document | 
ClassObjectOperations.ClassSubTest.createClassInstance(LibrarySession sess,
                   ClassObject clss)
Create Instances of newly created classes 
 | 
Document | 
ClassObjectOperations.T1kTest.createDocFromClass(LibrarySession sess,
                  ClassObject clss)  | 
protected Document | 
ClassObjectOperations.createDocument(LibrarySession session,
              DocumentDefinition docdef,
              Folder parent)
Creates a Document. 
 | 
Document | 
FolderOperations.CreateFolderTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname)  | 
Document | 
FolderOperations.FolderRefTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname)  | 
Document | 
FolderOperations.FolderCopyTest.createDocument(LibrarySession sess,
              Folder parentFolder,
              String objname)  | 
Document | 
SearchOperations.SavedSearchTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname,
              String catName)  | 
Document | 
SearchOperations.FrqSearchTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname,
              String catName,
              boolean should_load_doc)  | 
Document | 
SearchOperations.AclSearchTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname,
              String catName,
              boolean should_load_doc)  | 
Document | 
SearchOperations.BindSearchTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname,
              String catName,
              boolean should_load_doc)  | 
Document | 
SearchOperations.OperatorsSearchTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname,
              String catName,
              boolean should_load_doc)  | 
Document | 
SearchOperations.ExistenceSearchTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname,
              String catName,
              boolean versionable)  | 
Document | 
SearchOperations.NullValueSearchTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname,
              String catName,
              boolean versionable)  | 
Document | 
SearchOperations.JoinSearchTest.createDocument(LibrarySession sess,
              Folder parent_folder,
              String docname,
              String catName,
              Format format,
              boolean should_load_doc)  | 
protected Document | 
ClassObjectOperations.createDocument(LibrarySession session,
              Folder parent,
              String name,
              String classname,
              Format format,
              String contentpath)
Creates a Document. 
 | 
protected Document | 
ClassObjectOperations.createDocument(LibrarySession session,
              String name,
              ClassObject clss,
              Format format,
              String contentpath,
              Folder parent)
Creates a Document. 
 | 
Document | 
ClassObjectOperations.T1kTest.createDocumentFromNewClass(LibrarySession sess,
                          ClassObject clss)  | 
protected Document | 
RandomAccessOperations.ContentObjectUpdateTest.createTestDocument(String name,
                  AccessControlList acl,
                  Media media,
                  StorageGroup sg,
                  boolean readOnly)
Creates a "standard test document" used throughout this test. 
 | 
Document | 
VersioningOperations.DeletorTest.testCreation(LibrarySession s,
            Folder folder)  | 
protected Document | 
DocumentOperations.DocAclTest.verifyDocument(LibrarySession s,
              Family f)  | 
protected Document | 
VersioningOperations.VersionBasicTest.verifyDocument(LibrarySession s,
              Family f)  | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
VersioningOperations.VersionBasicTest.displayIsLocked(Document doc)  | 
void | 
VersioningOperations.VersionNonOwnerTest.makeVersionedNew(Document doc,
                AccessControlList acl,
                LibrarySession s,
                Folder parentfolder,
                boolean transferOwner)  | 
void | 
VersioningOperations.VersionNonOwnerTest.makeVersionedOld(Document doc,
                LibrarySession session,
                Folder parentfolder)  | 
void | 
VersioningOperations.VersionNonOwnerTest.testAddNewVersion(LibrarySession session,
                 Document doc)  | 
void | 
VersioningOperations.DeletorTest.testDelete(LibrarySession s,
          String otheruser,
          Document doc)  | 
protected void | 
VersioningOperations.DeletorTest.testTimeZone(LibrarySession s,
            Document doc)  | 
protected void | 
CommandProcessorOperations.writeContentToFile(Document doc,
                  String filename)  | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
RecipeDocument
This class is the bean-side representation of a RecipeDocument. 
 | 
class  | 
T1kDocument
A T1kDocument extends the basic Document for test purposes. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Document | 
Posting.addDocumentVersion(DocumentDefinition docDef)
Add a new Document version to this Posting's Family. 
 | 
Document | 
DocumentUpdateAction.getNewDocumentVersion()
Returns the new Document version setting. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
DocumentUpdateAction.addDocumentVersion(Document doc)
Adds a new Document version, prior to execution. 
 | 
Posting | 
Community.addPosting(Document doc)
Add a Posting to this Community. 
 | 
void | 
Posting.executeAddDocumentVersionAction(Document doc)
Execute a "Add Document Version" action to reflect the addition of a 
 new Document version. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Document | 
StixDomainObject.getDescriptionDocument()
Gets the document that holds the detailed description of the Stix object
 that is searchable via full text search. 
 | 
Document | 
StixReport.getSourceDocument()
Gets the source document for this Report. 
 | 
Document | 
StixReport.getTokensDocument()
Gets the text document holding the tokens correspoinding to the 
 Source Document of this Report. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
StixDomainObject.setDescriptionDocument(Document val)
Sets the document that holds the detailed description of the Stix object
 that is searchable via full text search. 
 | 
void | 
StixReport.setSourceDocument(Document val)
Sets The source document for this Report. 
 | 
void | 
StixReport.setTokensDocument(Document val)
Sets The text document holding the tokens correspoinding to the Source Document of this Report. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
PlayerDocument
A PlayerDocument is a group used within BaseballStatistics
 to track the primary scouting group. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
JsonPreparedSelector.define(Document doc)
Define the JsonPreparedSelector from a Document whose content
 is the JSON content. 
 | 
static void | 
ContentUtilities.writeDocumentContentToFile(Document doc,
                          String absFilename)
Write a Document's content to a local file, without append mode. 
 | 
static void | 
ContentUtilities.writeDocumentContentToFile(Document doc,
                          String absFilename,
                          boolean append)
Write a Document's content to a local file. 
 | 
| Constructor and Description | 
|---|
JsonPreparedSelector(Document doc)
Constructs a JsonPreparedSelector from a Document whose content
 is the JSON content. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Document | 
Utils.getDocument(LibrarySession ls,
           long id)
Returns the Document from a given ID or throws an exception if
 the item cannot be found or it is not a Document. 
 | 
static Document | 
Utils.getDocument(LibrarySession ls,
           Long id)
Returns the Document from a given ID or throws an exception if
 the item cannot be found or it is not a Document. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Document | 
CreateDocumentContext.getDocument()
Gets the returning document. 
 | 
Document | 
IfsCreateDocumentContext.getDocument()
Gets the returning document. 
 | 
protected Document | 
IfsUploadFileCommand.runCreateDocumentCommand(LibrarySession session,
                        String name,
                        InputStream stream,
                        Folder folder,
                        AccessControlList acl)
Execute an IfsCreateDocumentCommand. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
CreateDocumentContext.setDocument(Document doc)
Sets the returning document. 
 | 
void | 
IfsCreateDocumentContext.setDocument(Document doc)
Sets the returning document. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
MailDocument
The MailDocument class is ... 
 | 
class  | 
Rfc822Message
The Rfc822Message class is the main class to handle iFS email objects. 
 | 
class  | 
TieMailDocument
The TieMailDocument class is a placeholder 
 for performing overrides for all MailDocument subclasses. 
 | 
class  | 
TieRfc822Message
The TieRfc822Message class is a placeholder 
 for performing overrides for all Rfc822Message subclasses. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
BodyPart.setMsg(Document msg)  | 
| Modifier and Type | Method and Description | 
|---|---|
Document | 
OfficeSaveDetector.detectOnCreate(LibrarySession sess,
              DocumentDefinition def,
              String name,
              Folder f)
This function attempts to detect an edit in place. 
 | 
Document | 
OfficeSaveDetector.detectOnMove(LibrarySession sess,
            PublicObject po,
            Folder from,
            Folder to,
            String toName)
This function attempts to detect an Office save on a move. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
OfficeSaveDetector.deleteDoc(LibrarySession sess,
         Document doc,
         Folder folder,
         boolean freeIfLast)
This function pretends to delete the given document. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Document | 
PublicObjectUtilities.createDocument(Folder parent,
              InputStream in,
              String name,
              AccessControlList acl,
              boolean takeAclFromParent)
encapsulates plain non-versioned document creation given a parent folder,
 a name, and an inputstream; 
 will not update a prior existing object in parent, 
 will throw an IfsException simply because an object already exists 
 in parent with name 
 | 
Document | 
PublicObjectUtilities.createDocument(Folder parent,
              InputStream in,
              String name,
              String classname,
              AccessControlList acl,
              boolean takeAclFromParent)
encapsulates plain non-versioned document creation given a parent folder,
 a name, and an inputstream; 
 will not update a prior existing object in parent, 
 will throw an IfsException simply because an object already exists 
 in parent with name 
 | 
Document | 
PublicObjectUtilities.updateFolderedPublicObjectWithVersioning(Folder parent,
                                        InputStream in,
                                        String name,
                                        AccessControlList acl,
                                        boolean takeAclFromParent)
encapsulates the item update given a parent folder, a name, and an 
 inputstream; 
 will update a prior existing object in parent, 
 will throw an IfsException simply because an object doesn't exist in parent 
 | 
| Modifier and Type | Method and Description | 
|---|---|
LibraryObject | 
ParserHelper.parseExistingDocument(Document doc,
                     String workingName,
                     String workingParentFolderPath,
                     ParserCallback callback,
                     AccessControlList acl)
Handles the creation of objects given an existing Document. 
 | 
Copyright © 2025. All rights reserved.