Skip navigation links

Oracle® WebCenter Content Java API Reference for Imaging
11g Release 1 (11.1.1)

E12853-03


oracle.imaging
Class Search.SelectedField

java.lang.Object
  extended by oracle.imaging.Search.SelectedField

All Implemented Interfaces:
java.io.Serializable
Enclosing class:
Search

public static class Search.SelectedField
extends java.lang.Object
implements java.io.Serializable

The SelectedField class provides the information defining the source of the data being returned by a search. Each piece of data is defined by the Application and the Application$FieldDefinition within the application. Each of the preceding is uniquely identified by their associated NameId objects.

See Also:
Serialized Form

Nested Class Summary
static class Search.SelectedField.DocumentProperty
          This is an enumeration of the valid Imaging Attributes that may be returned in a search.
static class Search.SelectedField.SelectedFieldPk
          FOR INTERNAL USE ONLY

 

Constructor Summary
Search.SelectedField()
          The default constructor required to be explicitly declared for JAXB serialization.
Search.SelectedField(NameId applicationId, NameId fieldId)
          Constructs a SelectedField instance from the identifiers for the Application and the Application$FieldDefinition.

 

Method Summary
 NameId getApplicationId()
          Gets the NameId identifier for the Application.
 NameId getFieldId()
          Gets the NameId identifier for the Application$FieldDefinition.
 Search.SelectedField.DocumentProperty getProperty()
          Gets the document property Search$SelectedField$DocumentProperty being used as the source for this Search$ResultColumn.
 void setApplicationId(NameId applicationId)
          Sets the NameId identifier for the Application.
 void setFieldId(NameId fieldDefId)
          Sets the NameId identifier for the Application$FieldDefinition.
 void setProperty(Search.SelectedField.DocumentProperty property)
          Sets the source of the data for this Search$ResultColumn to be a property of the document.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

Search.SelectedField

public Search.SelectedField()
The default constructor required to be explicitly declared for JAXB serialization.

Search.SelectedField

public Search.SelectedField(NameId applicationId,
                            NameId fieldId)
Constructs a SelectedField instance from the identifiers for the Application and the Application$FieldDefinition.
Parameters:
applicationId - The identifier for the application.
fieldId - The identifier for the field definition.

Method Detail

getFieldId

public NameId getFieldId()
Gets the NameId identifier for the Application$FieldDefinition.
Returns:
The field definition identifier.

setFieldId

public void setFieldId(NameId fieldDefId)
Sets the NameId identifier for the Application$FieldDefinition.
Parameters:
fieldDefId - The field definition identifier.

getApplicationId

public NameId getApplicationId()
Gets the NameId identifier for the Application.
Returns:
The application identifier.

setApplicationId

public void setApplicationId(NameId applicationId)
Sets the NameId identifier for the Application.
Parameters:
applicationId - The application identifier.

getProperty

public Search.SelectedField.DocumentProperty getProperty()
Gets the document property Search$SelectedField$DocumentProperty being used as the source for this Search$ResultColumn.
Returns:
The document property.

setProperty

public void setProperty(Search.SelectedField.DocumentProperty property)
Sets the source of the data for this Search$ResultColumn to be a property of the document.
Parameters:
property - The document property.

Skip navigation links

Oracle® WebCenter Content Java API Reference for Imaging
11g Release 1 (11.1.1)

E12853-03


Copyright © 2010, 2011, Oracle and/or its affiliates. All rights reserved.