Class ValidValueManagement

    • Constructor Summary

      Constructors 
      Constructor Description
      ValidValueManagement​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      ValidValueManagement​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      ValidValueManagement​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      ValidValueManagement​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize)
      Create a new client that is going to be used in an OMAG Server.
      ValidValueManagement​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearReferenceValueTag​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String validValueGUID)
      Remove a reference value assignment relationship between an element and a valid value.
      void clearValidValueMember​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String validValueSetGUID, java.lang.String validValueMemberGUID)
      Remove a membership relationship between a validValue and a validValueSet that it belongs to.
      void clearValidValues​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String validValueGUID)
      Remove a valid value assignment relationship between an element and a valid value.
      java.lang.String createValidValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, ValidValueProperties validValueProperties)
      Create a new metadata element to represent a valid value.
      java.util.List<ValidValueElement> findValidValues​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of metadata elements that contain the search string.
      java.util.List<ValidValueElement> getAllValidValues​(java.lang.String userId, int startFrom, int pageSize)
      Retrieve the list of valid values.
      java.util.List<RelatedElement> getAssigneesOfReferenceValue​(java.lang.String userId, java.lang.String validValueGUID, int startFrom, int pageSize)
      Return information about the person roles linked to a validValue.
      java.util.List<RelatedElement> getConsumersOfValidValue​(java.lang.String userId, java.lang.String validValueGUID, int startFrom, int pageSize)
      Return information about the consumers linked to a validValue.
      java.util.List<ValidValueElement> getReferenceValues​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Return information about the valid values linked as reference value tags to an element.
      java.util.List<ValidValueElement> getSetsForValidValue​(java.lang.String userId, java.lang.String validValueGUID, int startFrom, int pageSize)
      Page through the list of valid value sets that a valid value definition/set belongs to.
      ValidValueElement getValidValueByGUID​(java.lang.String userId, java.lang.String validValueGUID)
      Retrieve the metadata element with the supplied unique identifier.
      java.util.List<ValidValueElement> getValidValuesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of metadata elements with a matching qualified or display name.
      java.util.List<ValidValueElement> getValidValueSetMembers​(java.lang.String userId, java.lang.String validValueSetGUID, int startFrom, int pageSize)
      Page through the members of a valid value set.
      ValidValueElement getValidValuesForConsumer​(java.lang.String userId, java.lang.String elementGUID)
      Return information about the valid value set linked to an element as its set of valid values.
      void removeValidValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String validValueGUID)
      Remove the metadata element representing a valid value.
      void setupReferenceValueTag​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, ReferenceValueAssignmentProperties properties, java.lang.String validValueGUID)
      Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
      void setupValidValueMember​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String validValueSetGUID, ValidValueMembershipProperties properties, java.lang.String validValueMemberGUID)
      Create a membership relationship between a validValue and a validValueSet that it belongs to.
      void setupValidValues​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, ValidValueAssignmentProperties properties, java.lang.String validValueGUID)
      Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.
      void updateValidValue​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String validValueGUID, boolean isMergeUpdate, ValidValueProperties validValueProperties)
      Update the metadata element representing a valid value.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait