|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface InputService
Method Summary | |
---|---|
NameId |
createInput(Input input) Adds a new Input to the Imaging system. |
void |
deleteInput(NameId input) Deletes an existing input based on its name, ID, or both. |
java.util.List<java.lang.String> |
getDataSourceContent(Input parsingInput, java.lang.String dataSource, int startPosition, int sampleRange) Gets the raw data of a sample data source and returns it in a list of strings. |
Input |
getInput(NameId id, Input.SectionSet sectionSet) Retrieves an Input with the requested sections filled out. |
java.util.List<Input> |
getInputs(java.util.List<NameId> ids, Input.SectionSet sectionSet) |
java.util.List<java.lang.String> |
getInputSectionsForDataSource(Input inputInfo, boolean useSampleSource, int startPosition, int endPosition) Gets the set of Input Sections available in the specified Input Source. |
java.util.List<Input> |
getOnlineInputs() Retrieves a list of the Input s that are currently online. |
java.util.List<NameId> |
listInputs(Input.Ability ability) Retrieves an array containing the NameId of each Input in the system. |
java.util.List<java.lang.String> |
listSampleDataSources(java.lang.String inputSourceName) Retrieves a list of sample Data Sources for a particular Input Source. |
void |
modifyInput(Input input, Input.SectionSet sectionSet) |
void |
modifyState(NameId id, Input.StateUpdate update) Updates the specified field on the Input whose name and/or ID is provided. |
void |
modifyStates(NameId id, Input.StateUpdate[] updates) |
void |
saveSampleDataSource(java.lang.String inputSource, javax.activation.DataHandler sampleData, java.lang.String sampleName) This method allows the caller to save a data stream to the Data Sample store on the server and make it available for future use. |
Method Detail |
---|
NameId createInput(Input input) throws ImagingException, ValidationException
Input
to the Imaging system. The new input will be validated before being added to ensure that it defines values for all of the necessary fields, and that the values defined are valid.input
- the new input definitionImagingException
- Thrown if the input is not properly defined, does not have a unique name, or an error is encountered while creating it.ValidationException
Input
void deleteInput(NameId input) throws ImagingException
input
- the name, ID, or both, of the input to deleteImagingException
- Thrown if the input cannot be found, or cannot be deleted.Input getInput(NameId id, Input.SectionSet sectionSet) throws ImagingException
Input
with the requested sections filled out. The operation will only return those sections specified by the sectionFlags
parameter. The operation will throw an exception if the requested application does not exist or the requesting user does not have permissions to view it.
The Input$SectionFlag
s provided are used to determine which aspects of the input definition should be populated in the returned definition. If null
, or an empty array, is passed, the definition is returned with only its most basic information filled in, and the non-requested sections left null
.
id
- the name, ID, or both, of the input to retrievesectionSet
- the sections of the input which should be populatedImagingException
- Thrown if the input cannot be found, or its data cannot be loadedjava.util.List<Input> getInputs(java.util.List<NameId> ids, Input.SectionSet sectionSet) throws ImagingException
ImagingException
java.util.List<Input> getOnlineInputs() throws ImagingException
Input
s that are currently online. The inputs returned are not fully populated. Instead, they contain only the values which would be returned by calling getInput(NameId, oracle.imaging.Input.SectionSet)
and providing null
for the section flags. If there are currently no online inputs, an empty list is returned.
If a listing of all inputs is desired, whether they are currently online or not, the listInputs(oracle.imaging.Input.Ability)
method should be used instead.
Note: There is no method provided for retrieving all inputs, nor for retrieving online inputs with specific sections populated.
ImagingException
- Thrown if the list of online inputs cannot be retrieved, or name/IDs for the inputs cannot be loadedjava.util.List<NameId> listInputs(Input.Ability ability) throws ImagingException
NameId
of each Input
in the system. Both online and offline inputs will be returned by this method. If no inputs have been created, an empty list is returned.
If a listing of only the online inputs in the system is desired, getOnlineInputs()
should be used instead.
ability
- Returns only inputs the current user has specific to that ability.
For example, to return back a list of inputs the current user can manage, the Input.Ability.MANAGE
enumeration should be specified.
ImagingException
void modifyInput(Input input, Input.SectionSet sectionSet) throws ImagingException, ValidationException
ImagingException
ValidationException
void modifyState(NameId id, Input.StateUpdate update) throws ImagingException
Input
whose name and/or ID is provided.
To update multiple fields on the input with a single call, which is generally much more efficient, InputService#modifyState(oracle.imaging.NameId,oracle.imaging.Input.StateUpdate[])
should be used instead.
id
- the name, ID, or both, of the input to updateupdate
- the new value, and its field, to apply to the inputImagingException
- Thrownvoid modifyStates(NameId id, Input.StateUpdate[] updates) throws ImagingException
ImagingException
java.util.List<java.lang.String> listSampleDataSources(java.lang.String inputSourceName) throws ImagingException
inputSourceName
- The name of the Input Source to get data sources forImagingException
- If there any errors getting the data source list.java.util.List<java.lang.String> getDataSourceContent(Input parsingInput, java.lang.String dataSource, int startPosition, int sampleRange) throws ImagingException
parsingInput
- An Input definition that contains encough information to parse the input streamdataSource
- The data source identifier to readstartPosition
- The location to start gathering data inputSectionsampleRange
- How many rows of data to returnImagingException
- If there are any errors loading and reading the source data, or if the specified data source is a production data source.java.util.List<java.lang.String> getInputSectionsForDataSource(Input inputInfo, boolean useSampleSource, int startPosition, int endPosition) throws ImagingException
Input$FieldMap
InputSection to define the input source of a mapping.inputInfo
- The Input Definition that has all the information on how to parse the data source. At this time only the Input.SourceProperties section must be completely filled out to get an accurate list of Input Sections.useSampleSource
- A flag that if set to true tells the parser it should try listing sections from the Input's Sample Data Source instead of the normal Input Source.startPosition
- Where to start inspecting the data source for Input SectionsendPosition
- Where to stop examining the data source for Input SectionsImagingException
- For any errors that occur examing the data source.void saveSampleDataSource(java.lang.String inputSource, javax.activation.DataHandler sampleData, java.lang.String sampleName) throws ImagingException
inputSource
- The ID of the Input Source that the sample is being saved for.sampleData
- The data stream of the data to save.sampleName
- What to name the data in the sample store.ImagingException
- If saving sample data is not supported or if an error occurrs attemping to save the stream then an error will be thrown.
|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |