Skip navigation links

oracle.imaging
Class Document

java.lang.Object
oracle.imaging.Document

All Implemented Interfaces:

java.io.Serializable

public class Document

extends java.lang.Object

implements java.io.Serializable

A data structure representing the properties of a document An imaging document is identified by both name and an guid property. Additionally, the structure may contain a section detailing simple properties for the applications and a collection of field values containing the primary application index meta data values for the document.

See Also:

Serialized Form

Nested Class Summary

static class	Document.Ability Enumeration validating that the current user has this ability on the applications.
static class	Document.FieldValue A data structure containing properties for a single meta data value for the document.
static class	Document.Permissions A data structure specifying a user's permissions to a document within an application.
static class	Document.Properties A data structure containing general properties for an imaging document.
static class	Document.SectionFlag Flags that identify which sections are applicable when using the Document data structure in various DocumentService operations.
static class	Document.SectionSet

Constructor Summary

Document()
The default constructor required to be explicitly declared for JAXB serialization.

Method Summary

static java.util.List<BasePermissions.Permission>	getAvailablePermissions() Returns all Permission keys which can be set on a Document, including those which are not directly persisted by imaging.
java.util.List<Document.FieldValue>	getFieldValues() Gets the document FieldValues section property.
java.util.List<AuditEvent>	getHistory() Gets the History section property.
java.lang.String	getId() Gets the document Id property.
static Document.Permissions	getIpmManagedDocPermissions(Document.Permissions original) New to 11.1.1.4.0 : Returns a Document.Permissions copy where only imaging-managed permissions have been copied from the original.
static Application.DocumentSecurity	getIpmManagedDocSecurity(Application.DocumentSecurity original) New to 11.1.1.4.0 : Returns a Application.DocumentSecurity copy where only imaging-managed permissions have been copied from the original.
static java.util.List<BasePermissions.Permission>	getIpmManagedPermissions() Returns the Permissions keys that are managed directly by imaging.
java.lang.String	getName() Gets the document Name property.
Document.Permissions	getPermissions() Gets the document Permissions section property.
Document.Properties	getProperties() Gets the document Properties section property.
void	setFieldValues(java.util.List<Document.FieldValue> fieldValues) Sets the document FieldValues section property.
void	setHistory(java.util.List<AuditEvent> history) Sets the History section property.
void	setId(java.lang.String id) Sets the document Id property.
void	setName(java.lang.String name) Sets the document Name property.
void	setPermissions(Document.Permissions permissions) A convenience method for JAXB and Imaging services.
void	setProperties(Document.Properties properties) Sets the document Properties section property.

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

The default constructor required to be explicitly declared for JAXB serialization.

Method Detail

getAvailablePermissions

public static java.util.List<BasePermissions.Permission> getAvailablePermissions()

Returns all Permission keys which can be set on a Document, including those which are not directly persisted by imaging. For only the permissions that should be persisted by imaging,

See Also:

getIpmManagedPermissions()

getIpmManagedPermissions

public static java.util.List<BasePermissions.Permission> getIpmManagedPermissions()

Returns the Permissions keys that are managed directly by imaging.

getIpmManagedDocPermissions

public static Document.Permissions getIpmManagedDocPermissions(Document.Permissions original)

New to 11.1.1.4.0 : Returns a Document.Permissions copy where only imaging-managed permissions have been copied from the original. All non-managed permissions are set false.

Parameters:

original -

getIpmManagedDocSecurity

public static Application.DocumentSecurity getIpmManagedDocSecurity(Application.DocumentSecurity original)

New to 11.1.1.4.0 : Returns a Application.DocumentSecurity copy where only imaging-managed permissions have been copied from the original. All non-managed permissions are set false.

Parameters:

original -

setName

public void setName(java.lang.String name)

Sets the document Name property.

Parameters:

name - The new document Name property value.

getName

public java.lang.String getName()

Gets the document Name property.

Returns:

The document Name property value

setId

public void setId(java.lang.String id)

Sets the document Id property.

Parameters:

id - The new document Id property value.

getId

public java.lang.String getId()

Gets the document Id property.

Returns:

The document Id property value

setProperties

public void setProperties(Document.Properties properties)

Sets the document Properties section property.

Parameters:

properties - The new document Properties section value.

getProperties

public Document.Properties getProperties()

Gets the document Properties section property.

Returns:

The document Properties section property value

setFieldValues

public void setFieldValues(java.util.List<Document.FieldValue> fieldValues)

Sets the document FieldValues section property.

Parameters:

fieldValues - The new document FieldValues section property value.

getFieldValues

public java.util.List<Document.FieldValue> getFieldValues()

Gets the document FieldValues section property.

Returns:

The document FieldValues section property value

setPermissions

public void setPermissions(Document.Permissions permissions)

A convenience method for JAXB and Imaging services. Calling this method to set permissions will have no affect. Instead, use the ApplicationService.createApplication or ApplicationService.modifyApplication services, using the Application.SectionFlag.DOCUMENTSECURITY section to change a user's permissions to an application's documents.

Parameters:

permissions - the permissions set by JAXB or Imaging services

getPermissions

public Document.Permissions getPermissions()

Gets the document Permissions section property.

Returns:

The document Permissions section property value

getHistory

public java.util.List<AuditEvent> getHistory()

Gets the History section property.

Returns:

The History section property value

setHistory

public void setHistory(java.util.List<AuditEvent> history)

Sets the History section property.

Parameters:

history - A new History section property value

Skip navigation links