Interface OrganizationManagementInterface

  • All Known Implementing Classes:
    OrganizationManagement

    public interface OrganizationManagementInterface
    OrganizationManagementInterface defines the client interface for setting up the profiles, roles and relationships for an organization.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String addContactMethod​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String actorProfileGUID, ContactMethodProperties properties)
      Add a new contact method to the profile.
      java.lang.String createActorProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, ActorProfileProperties properties, ContributionRecord contributionRecord)
      Create a definition of an actor profile.
      java.lang.String createPersonRole​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, PersonRoleProperties properties)
      Create a definition of a person role.
      void deleteActorProfile​(java.lang.String userId, java.lang.String actorProfileGUID, java.lang.String externalSourceGUID, java.lang.String externalSourceName)
      Remove the definition of an actor profile.
      void deleteContactMethod​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String contactMethodGUID)
      Remove an obsolete contact method from the profile.
      void deletePersonRole​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String personRoleGUID)
      Remove the definition of a person role.
      java.util.List<ActorProfileElement> findActorProfiles​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of matching profiles for the search string.
      java.util.List<PersonRoleElement> findPersonRoles​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of matching roles for the search string.
      ActorProfileElement getActorProfileByGUID​(java.lang.String userId, java.lang.String actorProfileGUID)
      Return information about a specific actor profile.
      ActorProfileElement getActorProfileByUserId​(java.lang.String userId, java.lang.String actorProfileUserId)
      Return information about a specific actor profile.
      java.util.List<ActorProfileElement> getActorProfiles​(java.lang.String userId, int startFrom, int pageSize)
      Return information about all actor profiles.
      java.util.List<ActorProfileElement> getActorProfilesByLocation​(java.lang.String userId, java.lang.String locationGUID, int startFrom, int pageSize)
      Return information about the actor profiles associated with a location.
      java.util.List<ActorProfileElement> getActorProfilesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Return information about matching named actor profiles.
      java.util.List<PersonRoleAppointee> getAppointees​(java.lang.String userId, java.lang.String personRoleGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of people appointed to a particular role.
      java.util.List<PersonRoleElement> getLeadershipRolesForTeam​(java.lang.String userId, java.lang.String teamGUID, int startFrom, int pageSize)
      Return information about the leadership person roles linked to a team.
      java.util.List<PersonRoleElement> getMembershipRolesForTeam​(java.lang.String userId, java.lang.String teamGUID, int startFrom, int pageSize)
      Return information about the membership person roles linked to a team.
      PersonRoleElement getPersonRoleByGUID​(java.lang.String userId, java.lang.String personRoleGUID)
      Return information about a specific person role.
      java.util.List<PersonRoleElement> getPersonRolesByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Return information about a named person role.
      java.lang.String linkPersonRoleToProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String personRoleGUID, java.lang.String personProfileGUID, AppointmentProperties properties)
      Link a person role to a person profile to show that that person is performing the role.
      void linkTeamPlayer​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String teamRoleGUID, java.lang.String teamProfileGUID, java.lang.String position, boolean leadershipPosition)
      Link a team leader person role or team member person role to a team profile.
      void linkTeamsInHierarchy​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String superTeamProfileGUID, java.lang.String subTeamProfileGUID, boolean delegationEscalationAuthority, java.util.Date effectiveFrom, java.util.Date effectiveTo)
      Link two related team/organization actor profiles together as part of a hierarchy.
      void unlinkPersonRoleFromProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String appointmentGUID)
      Remove the link between a person role and a person profile.
      void unlinkTeamPlayer​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String teamRoleGUID, java.lang.String teamProfileGUID, boolean leadershipPosition)
      Remove the link between a person role and a team profile.
      void unlinkTeamsInHierarchy​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String superTeamProfileGUID, java.lang.String subTeamProfileGUID)
      Remove the link between two actor profiles in the actor profile hierarchy.
      void updateActorProfile​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String actorProfileGUID, boolean isMergeUpdate, ActorProfileProperties properties, ContributionRecord contributionRecord)
      Update the definition of an actor profile.
      void updateAppointment​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String appointmentGUID, boolean isMergeUpdate, AppointmentProperties properties)
      Update the properties for the appointment of a person to a role.
      void updatePersonRole​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String personRoleGUID, boolean isMergeUpdate, PersonRoleProperties properties)
      Update the definition of a person role.
    • Method Detail

      • createActorProfile

        java.lang.String createActorProfile​(java.lang.String userId,
                                            java.lang.String externalSourceGUID,
                                            java.lang.String externalSourceName,
                                            ActorProfileProperties properties,
                                            ContributionRecord contributionRecord)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Create a definition of an actor profile. This could be for the whole organization, a team, a person or a system.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        properties - properties for a actor profile
        contributionRecord - optional properties for the contribution record
        Returns:
        unique identifier of actor profile
        Throws:
        InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • updateActorProfile

        void updateActorProfile​(java.lang.String userId,
                                java.lang.String externalSourceGUID,
                                java.lang.String externalSourceName,
                                java.lang.String actorProfileGUID,
                                boolean isMergeUpdate,
                                ActorProfileProperties properties,
                                ContributionRecord contributionRecord)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Update the definition of an actor profile.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        actorProfileGUID - unique identifier of actor profile
        isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
        properties - properties to change
        contributionRecord - additional properties for contribution record.
        Throws:
        InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • deleteActorProfile

        void deleteActorProfile​(java.lang.String userId,
                                java.lang.String actorProfileGUID,
                                java.lang.String externalSourceGUID,
                                java.lang.String externalSourceName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Remove the definition of an actor profile.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        actorProfileGUID - unique identifier of actor profile
        Throws:
        InvalidParameterException - guid or userId is null; guid is not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • addContactMethod

        java.lang.String addContactMethod​(java.lang.String userId,
                                          java.lang.String externalSourceGUID,
                                          java.lang.String externalSourceName,
                                          java.lang.String actorProfileGUID,
                                          ContactMethodProperties properties)
                                   throws InvalidParameterException,
                                          PropertyServerException,
                                          UserNotAuthorizedException
        Add a new contact method to the profile.
        Parameters:
        userId - the name of the calling user.
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        actorProfileGUID - identifier of the profile to update.
        properties - properties of contact method.
        Returns:
        unique identifier (guid) for the new contact method.
        Throws:
        InvalidParameterException - the userId is null or invalid. Another property is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • deleteContactMethod

        void deleteContactMethod​(java.lang.String userId,
                                 java.lang.String externalSourceGUID,
                                 java.lang.String externalSourceName,
                                 java.lang.String contactMethodGUID)
                          throws InvalidParameterException,
                                 PropertyServerException,
                                 UserNotAuthorizedException
        Remove an obsolete contact method from the profile.
        Parameters:
        userId - the name of the calling user.
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        contactMethodGUID - unique identifier (guid) for the obsolete contact method.
        Throws:
        InvalidParameterException - the userId is null or invalid. Another property is invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • linkTeamsInHierarchy

        void linkTeamsInHierarchy​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String superTeamProfileGUID,
                                  java.lang.String subTeamProfileGUID,
                                  boolean delegationEscalationAuthority,
                                  java.util.Date effectiveFrom,
                                  java.util.Date effectiveTo)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Link two related team/organization actor profiles together as part of a hierarchy. A team/organization actor profile can only have one parent but many child actor profiles.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        superTeamProfileGUID - unique identifier of the parent team profile
        subTeamProfileGUID - unique identifier of the child team profile
        delegationEscalationAuthority - can workflows delegate/escalate through this link?
        effectiveFrom - start date for the team relationship
        effectiveTo - end date for the team relationship
        Throws:
        InvalidParameterException - one of the guids is null or not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • unlinkTeamsInHierarchy

        void unlinkTeamsInHierarchy​(java.lang.String userId,
                                    java.lang.String externalSourceGUID,
                                    java.lang.String externalSourceName,
                                    java.lang.String superTeamProfileGUID,
                                    java.lang.String subTeamProfileGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Remove the link between two actor profiles in the actor profile hierarchy.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        superTeamProfileGUID - unique identifier of the parent actor profile
        subTeamProfileGUID - unique identifier of the child actor profile
        Throws:
        InvalidParameterException - one of the guids is null or not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • createPersonRole

        java.lang.String createPersonRole​(java.lang.String userId,
                                          java.lang.String externalSourceGUID,
                                          java.lang.String externalSourceName,
                                          PersonRoleProperties properties)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Create a definition of a person role.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        properties - properties for a person role
        Returns:
        unique identifier of person role
        Throws:
        InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • updatePersonRole

        void updatePersonRole​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String personRoleGUID,
                              boolean isMergeUpdate,
                              PersonRoleProperties properties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Update the definition of a person role.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        personRoleGUID - unique identifier of person role
        isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
        properties - properties to change
        Throws:
        InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • deletePersonRole

        void deletePersonRole​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String personRoleGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove the definition of a person role.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        personRoleGUID - unique identifier of person role
        Throws:
        InvalidParameterException - guid or userId is null; guid is not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • linkPersonRoleToProfile

        java.lang.String linkPersonRoleToProfile​(java.lang.String userId,
                                                 java.lang.String externalSourceGUID,
                                                 java.lang.String externalSourceName,
                                                 java.lang.String personRoleGUID,
                                                 java.lang.String personProfileGUID,
                                                 AppointmentProperties properties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Link a person role to a person profile to show that that person is performing the role.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        personRoleGUID - unique identifier of the person role
        personProfileGUID - unique identifier of the person profile
        properties - optional properties for the appointment
        Returns:
        unique identifier of the appointment
        Throws:
        InvalidParameterException - one of the guids is null or not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • updateAppointment

        void updateAppointment​(java.lang.String userId,
                               java.lang.String externalSourceGUID,
                               java.lang.String externalSourceName,
                               java.lang.String appointmentGUID,
                               boolean isMergeUpdate,
                               AppointmentProperties properties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
        Update the properties for the appointment of a person to a role.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        appointmentGUID - unique identifier of the appointment relationship
        isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
        properties - properties to change
        Throws:
        InvalidParameterException - one of the guids is null or not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • unlinkPersonRoleFromProfile

        void unlinkPersonRoleFromProfile​(java.lang.String userId,
                                         java.lang.String externalSourceGUID,
                                         java.lang.String externalSourceName,
                                         java.lang.String appointmentGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Remove the link between a person role and a person profile.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        appointmentGUID - unique identifier of the appointment relationship
        Throws:
        InvalidParameterException - one of the guids is null or not known
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • linkTeamPlayer

        void linkTeamPlayer​(java.lang.String userId,
                            java.lang.String externalSourceGUID,
                            java.lang.String externalSourceName,
                            java.lang.String teamRoleGUID,
                            java.lang.String teamProfileGUID,
                            java.lang.String position,
                            boolean leadershipPosition)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
        Link a team leader person role or team member person role to a team profile.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        teamRoleGUID - unique identifier of the person role
        teamProfileGUID - unique identifier of the team profile
        position - position name of the role in the team
        leadershipPosition - is this a leadership position?
        Throws:
        InvalidParameterException - one of the guids is null or not known; the person role is not a team member or team leader
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • unlinkTeamPlayer

        void unlinkTeamPlayer​(java.lang.String userId,
                              java.lang.String externalSourceGUID,
                              java.lang.String externalSourceName,
                              java.lang.String teamRoleGUID,
                              java.lang.String teamProfileGUID,
                              boolean leadershipPosition)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove the link between a person role and a team profile.
        Parameters:
        userId - calling user
        externalSourceGUID - guid of the software server capability entity that represented the external source - null for local
        externalSourceName - name of the software server capability entity that represented the external source
        teamRoleGUID - unique identifier of the person role
        teamProfileGUID - unique identifier of the team profile
        leadershipPosition - is this a leadership position?
        Throws:
        InvalidParameterException - one of the guids is null or not known; the person role is not a team member or team leader
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem