Skip navigation links

oracle.imaging
Class Input

java.lang.Object
oracle.imaging.BaseId
oracle.imaging.Definition
oracle.imaging.Input

public class Input

extends Definition

Nested Class Summary

static class	Input.Ability Enumeration validating that the current user has this ability on the inputs.
static class	Input.FieldMap Defines a mapping between an input source field to an Applicationfield which is used to establish the flow of index data during document creation within the InputService.
static class	Input.Mappings Defines the Input.FieldMapings for one or an Application's primary index, and provides the NameIdof the Applicationproviding the source fields used.
static class	Input.Properties
static class	Input.SectionFlag Flags that identify which sections are applicable to a specific request.
static class	Input.SectionSet
static class	Input.SourceProperties
static class	Input.SourceSetting
static class	Input.StateFlag Flags that identify which piece or pieces of an input should be updated, when a call is made to InputService#modifyState(NameId,StateUpdate[]).
static class	Input.StateUpdate

Nested classes/interfaces inherited from class oracle.imaging.Definition

Definition.DefinitionPk, Definition.Permissions, Definition.SectionPk, Definition.Security, Definition.SequencePk

Field Summary

static java.lang.String	CSV_INPUT_SOURCE_NAME The name that the Input definition and Input Service uses to identify the default system CSV Input Source.
static java.lang.String	INPUT_FILE_DELIMITER_KEY The name of the parsing configuration key that an Input Definition uses to determine what character to use for delimiting fields in an input file.
static java.lang.String	INPUT_FILE_ENCODING_KEY A key for the Input Definition that specifies a specific encoding for an input file.
protected Definition.Permissions	permissions
protected java.util.List<Definition.Security>	security

Fields inherited from class oracle.imaging.Definition

description, id, name, version

Fields inherited from class oracle.imaging.BaseId

ID_COMPARATOR, NAME_COMPARATOR

Constructor Summary

Input()

Input(long id)

Input(long id, java.lang.String name)

Input(java.lang.String name)

Method Summary

java.util.List<AuditEvent>	getHistory() Gets the History section property.
Input.Mappings	getMappings() Retrieves the currently-set Input.Mappingsfor this input.
Definition.Permissions	getPermissions() Gets the Permissions section property.
Input.Properties	getProperties() Retrieves the properties section of the Definition.
java.util.List<Definition.Security>	getSecurity() Gets the Security section property.
Input.SourceProperties	getSourceProperties() Retrieves the definition's currently-set Input Source Properties.
protected void	prePersist()
void	removeParentReferences()
void	setHistory(java.util.List<AuditEvent> history) Sets the History section property.
void	setMappings(Input.Mappings mappings) Sets the Input.Mappings to be used for this input.
void	setPermissions(Definition.Permissions permissions) A convenience method for JAXB and Imaging services.
void	setProperties(Input.Properties properties) Sets the properties section of the Input Definition.
void	setSecurity(java.util.List<Definition.Security> security)
void	setSourceProperties(Input.SourceProperties properties) Applies a new set of Input Source information to the input definition

Methods inherited from class oracle.imaging.Definition

getDescription, getId, getName, setDescription, setId, setName

Methods inherited from class oracle.imaging.BaseId

equals, hashCode, nameTrimOrNull, toNameId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CSV_INPUT_SOURCE_NAME

public static final java.lang.String CSV_INPUT_SOURCE_NAME

The name that the Input definition and Input Service uses to identify the default system CSV Input Source.

See Also:

Constant Field Values

INPUT_FILE_DELIMITER_KEY

public static final java.lang.String INPUT_FILE_DELIMITER_KEY

The name of the parsing configuration key that an Input Definition uses to determine what character to use for delimiting fields in an input file.

See Also:

Constant Field Values

INPUT_FILE_ENCODING_KEY

public static final java.lang.String INPUT_FILE_ENCODING_KEY

A key for the Input Definition that specifies a specific encoding for an input file.

See Also:

Constant Field Values

permissions

protected Definition.Permissions permissions

security

protected java.util.List<Definition.Security> security

Constructor Detail

Input

public Input()

Input

public Input(long id)

Input

public Input(long id,
             java.lang.String name)

Input

public Input(java.lang.String name)

Method Detail

prePersist

protected void prePersist()

removeParentReferences

public void removeParentReferences()

getMappings

public Input.Mappings getMappings()

Retrieves the currently-set Input.Mappingsfor this input.

Returns:

the current input primaryMappings

setMappings

public void setMappings(Input.Mappings mappings)

Sets the Input.Mappings to be used for this input.

Parameters:

mappings - the desired input primaryMappings

getProperties

public Input.Properties getProperties()

Retrieves the properties section of the Definition.

Returns:

the currently-set input properties

setProperties

public void setProperties(Input.Properties properties)

Sets the properties section of the Input Definition.

Parameters:

properties - the properties section to save in the definition

getSourceProperties

public Input.SourceProperties getSourceProperties()

Retrieves the definition's currently-set Input Source Properties.

Returns:

the currently-set input source properties

setSourceProperties

public void setSourceProperties(Input.SourceProperties properties)

Applies a new set of Input Source information to the input definition

Parameters:

properties - the new properties to save to the definition

getPermissions

public Definition.Permissions getPermissions()

Gets the Permissions section property.

Specified by:

getPermissions in class Definition

Returns:

The Permissions section property value

setPermissions

public void setPermissions(Definition.Permissions permissions)

A convenience method for JAXB and Imaging services. Calling this method to set permissions will have no affect. Instead, use the InputService#createInput or InputService#modifyInput services, using the {@link Input.SectionFlag#SECURITY} section to change the security member permissions to an input.

Specified by:

setPermissions in class Definition

Parameters:

permissions - the permissions set by JAXB or Imaging services

getSecurity

public java.util.List<Definition.Security> getSecurity()

Gets the Security section property.

Specified by:

getSecurity in class Definition

Returns:

The Security section property value

setSecurity

public void setSecurity(java.util.List<Definition.Security> security)

Specified by:

setSecurity in class Definition

getHistory

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

Gets the History section property.

Specified by:

getHistory in class Definition

Returns:

The History section property value

setHistory

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

Sets the History section property.

Specified by:

setHistory in class Definition

Parameters:

history - A new History section property value

Skip navigation links