Class CommunityProfileBaseClient

    • Constructor Summary

      Constructors 
      Constructor Description
      CommunityProfileBaseClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      CommunityProfileBaseClient​(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.
      CommunityProfileBaseClient​(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.
      CommunityProfileBaseClient​(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.
      CommunityProfileBaseClient​(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 clearAssignmentScope​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String scopeGUID)
      Remove an "AssignmentScope" relationship between two referenceables.
      void clearMoreInformation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String detailGUID)
      Remove a "MoreInformation" relationship between two referenceables.
      void clearResource​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String resourceGUID)
      Remove a "ResourceList" relationship between two referenceables.
      void clearStakeholder​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String stakeholderGUID)
      Remove a "Stakeholder" relationship between two referenceables.
      java.util.List<RelatedElement> getAssignedActors​(java.lang.String userId, java.lang.String scopeGUID, int startFrom, int pageSize)
      Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.
      java.util.List<RelatedElement> getAssignedScopes​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.
      java.util.List<RelatedElement> getDescriptiveElements​(java.lang.String userId, java.lang.String detailGUID, int startFrom, int pageSize)
      Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
      java.util.List<RelatedElement> getMoreInformation​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
      java.util.List<RelatedElement> getResourceList​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
      java.util.List<RelatedElement> getStakeholderCommissionedElements​(java.lang.String userId, java.lang.String stakeholderGUID, int startFrom, int pageSize)
      Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.
      java.util.List<RelatedElement> getStakeholders​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.
      java.util.List<RelatedElement> getSupportedByResource​(java.lang.String userId, java.lang.String resourceGUID, int startFrom, int pageSize)
      Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
      void removeReferenceable​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, java.lang.String elementGUIDParameterName, java.lang.String urlTemplate, java.lang.String methodName)
      Remove the metadata element.
      void setupAssignmentScope​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, AssignmentScopeProperties properties, java.lang.String scopeGUID)
      Create an "AssignmentScope" relationship between an element and its scope.
      void setupMoreInformation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, RelationshipProperties properties, java.lang.String detailGUID)
      Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.
      void setupResource​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, ResourceListProperties properties, java.lang.String resourceGUID)
      Create a "ResourceList" relationship between a consuming element and an element that represents resources.
      void setupStakeholder​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String elementGUID, StakeholderProperties properties, java.lang.String stakeholderGUID)
      Create a "Stakeholder" relationship between an element and its stakeholder.
      void updateRelationship​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String primaryElementGUID, java.lang.String primaryElementGUIDParameterName, RelationshipProperties properties, java.lang.String secondaryElementGUID, java.lang.String secondaryElementGUIDParameterName, boolean isMergeUpdate, java.lang.String urlTemplate, java.lang.String methodName)
      Update the properties of the relationship between two elements.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CommunityProfileBaseClient

        public CommunityProfileBaseClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot,
                                          AuditLog auditLog)
                                   throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • CommunityProfileBaseClient

        public CommunityProfileBaseClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot)
                                   throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • CommunityProfileBaseClient

        public CommunityProfileBaseClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot,
                                          java.lang.String userId,
                                          java.lang.String password)
                                   throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • CommunityProfileBaseClient

        public CommunityProfileBaseClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot,
                                          java.lang.String userId,
                                          java.lang.String password,
                                          AuditLog auditLog)
                                   throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • CommunityProfileBaseClient

        public CommunityProfileBaseClient​(java.lang.String serverName,
                                          java.lang.String serverPlatformURLRoot,
                                          CommunityProfileRESTClient restClient,
                                          int maxPageSize)
                                   throws InvalidParameterException
        Create a new client that is going to be used in an OMAG Server.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - client that issues the REST API calls
        maxPageSize - maximum number of results supported by this server
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.