Package org.dlese.dpc.ndr.reader

Class GroupingObjectReader

java.lang.Object
org.dlese.dpc.ndr.reader.NdrObjectReader
org.dlese.dpc.ndr.reader.GroupingObjectReader
Direct Known Subclasses:
AggregatorReader, MetadataProviderReader
public abstract class GroupingObjectReader extends NdrObjectReader
Base class for MetadataProvider and Aggregator Readers with support for listing members, authorization, and service descriptions.
Author:
ostwald

  • Constructor Details

    • GroupingObjectReader

      public GroupingObjectReader(String handle) throws Exception
      Constructor for the GroupingObjectReader object at the specified NDR handle.
      Parameters:
      handle - NOT YET DOCUMENTED
      Throws:
      Exception - NOT YET DOCUMENTED

    • GroupingObjectReader

      public GroupingObjectReader(String handle, String format) throws Exception
      Constructor for the GroupingObjectReader object
      Parameters:
      handle - NOT YET DOCUMENTED
      format - NOT YET DOCUMENTED
      Throws:
      Exception - NOT YET DOCUMENTED

    • GroupingObjectReader

      public GroupingObjectReader(org.dom4j.Document ndrResponse) throws Exception
      Constructor for the GroupingObjectReader object for the provided Document representing a NDR "get" call for a MetadataProvider object.
      Parameters:
      ndrResponse - NOT YET DOCUMENTED
      Throws:
      Exception - NOT YET DOCUMENTED

    • GroupingObjectReader

      public GroupingObjectReader(org.dom4j.Document ndrResponse, String format) throws Exception
      Constructor for the GroupingObjectReader object
      Parameters:
      ndrResponse - NOT YET DOCUMENTED
      format - NOT YET DOCUMENTED
      Throws:
      Exception - NOT YET DOCUMENTED

  • Method Details

    • getChildToParentRelationship

      public abstract String getChildToParentRelationship()
      Gets the childToParentRelationship attribute of the GroupingObjectReader object
      Returns:
      The childToParentRelationship value

    • getServiceDescription

      public ServiceDescriptionReader getServiceDescription()
      Gets the serviceDescription attribute of the GroupingObjectReader object
      Returns:
      The serviceDescription value

    • getMemberHandles

      public List getMemberHandles() throws Exception
      Gets the metadata object handles for the GroupingObjectReader object
      Returns:
      The memberHandles value
      Throws:
      Exception - NOT YET DOCUMENTED

    • getMemberCount

      public int getMemberCount() throws Exception
      Gets the number of visible metadata records of the GroupingObjectReader object
      Returns:
      The number of members for this MDP
      Throws:
      Exception - NOT YET DOCUMENTED

    • getInactiveMemberHandles

      public List getInactiveMemberHandles() throws Exception
      Gets the handles of the inactive metadata objects of the GroupingObjectReader object
      Returns:
      The inactiveMemberHandles value
      Throws:
      Exception - NOT YET DOCUMENTED

    • getInactiveMemberCount

      public int getInactiveMemberCount() throws Exception
      Gets the number of inactive Members of the GroupingObjectReader object
      Returns:
      The inactiveMemberCount value
      Throws:
      Exception - NOT YET DOCUMENTED

    • isAuthorizedToChange

      public boolean isAuthorizedToChange()
      Returns true if the configured NCS_AGENT is authorized to change this object
      Returns:
      The authorizedToChange value

    • isAuthorizedToChange

      public boolean isAuthorizedToChange(String agentHandle)
      Returns true if specified agent is authorized to change this object.
      Parameters:
      agentHandle - the agent handle
      Returns:
      The authorizedToChange value