AgentReader (jOAI Java Documentation v3.3)

Field Summary
- Fields inherited from class org.dlese.dpc.ndr.reader.NdrObjectReader
  createdDate, doc, dsFormats, handle, lastModifiedDate, nativeDataStreamFormat, nsContext, objectType

Constructor Summary

Constructors
Constructor and Description
`AgentReader(org.dom4j.Document response)` Constructor for the AgentReader object with provided response (to ndr "get" call)
`AgentReader(java.lang.String handle)` Constructor for the AgentReader with provided handle

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`agentInit()`
`java.util.List`	`getAggregators()` Gets the aggregators that are related to this Agent via the aggregatorFor relationship.
`java.lang.String`	`getIdentifier()` Gets the identifier attribute of the AgentReader object
`java.lang.String`	`getIdentifierType()` Returns one of "HOST", "URL", "OTHER", depending on what form of id is present in the object.
`java.util.List`	`getMetadataProviders()` Gets the metadataProviders that are related to this Agent via the metadataProviderFor relationship.
`boolean`	`isAuthorizedToChange()` Returns true if the configured NCS_AGENT is authorized to change this agent.
`protected static void`	`pp(org.dom4j.Node node)`

Methods inherited from class org.dlese.dpc.ndr.reader.NdrObjectReader
getCanonicalNsdlDcDataStream, getCreated, getCreatedDate, getDataStream, getDataStream, getDocument, getFormats, getHandle, getLastModified, getLastModifiedDate, getNativeDataStream, getNativeDataStream, getNode, getNodes, getNodeText, getNsContext, getObjectType, getProperty, getPropertyValues, getRelationship, getRelationshipValues, getState, getXPath, initDataStreams, setDebug

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

- Constructor Detail
  - AgentReader
```
public AgentReader(java.lang.String handle)
            throws java.lang.Exception
```
    Constructor for the AgentReader with provided handle
    
    Parameters:
    
    handle - handle to Agent object in the NDR
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
  - AgentReader
```
public AgentReader(org.dom4j.Document response)
            throws java.lang.Exception
```
    Constructor for the AgentReader object with provided response (to ndr "get" call)
    
    Parameters:
    
    response - a dom4j.Document reperesentation of ndr GET response.
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
- Method Detail
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    Gets the identifier attribute of the AgentReader object
    
    Returns:
    
    The identifier value
  - getIdentifierType
```
public java.lang.String getIdentifierType()
```
    Returns one of "HOST", "URL", "OTHER", depending on what form of id is present in the object.
    
    Returns:
    
    The identifierType value
  - agentInit
```
protected void agentInit()
                  throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - isAuthorizedToChange
```
public boolean isAuthorizedToChange()
```
    Returns true if the configured NCS_AGENT is authorized to change this agent.
    
    Returns:
    
    The authorizedToChange value
  - getMetadataProviders
```
public java.util.List getMetadataProviders()
                                    throws java.lang.Exception
```
    Gets the metadataProviders that are related to this Agent via the metadataProviderFor relationship.
    
    Returns:
    
    The metadataProviders value
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
  - getAggregators
```
public java.util.List getAggregators()
                              throws java.lang.Exception
```
    Gets the aggregators that are related to this Agent via the aggregatorFor relationship.
    
    Returns:
    
    The aggregators value
    
    Throws:
    
    java.lang.Exception - NOT YET DOCUMENTED
  - pp
```
protected static void pp(org.dom4j.Node node)
```

Class AgentReader

Field Summary

Fields inherited from class org.dlese.dpc.ndr.reader.NdrObjectReader

Constructor Summary

Method Summary

Methods inherited from class org.dlese.dpc.ndr.reader.NdrObjectReader

Methods inherited from class java.lang.Object

Constructor Detail

AgentReader

AgentReader

Method Detail

getIdentifier

getIdentifierType

agentInit

isAuthorizedToChange

getMetadataProviders

getAggregators

pp