Class OrganizationManagement

  • All Implemented Interfaces:
    OrganizationManagementInterface

    public class OrganizationManagement
    extends java.lang.Object
    implements OrganizationManagementInterface
    OrganizationManagement is the client used by the Organization Integrator OMIS that is responsible with synchronizing organizational structures, profiles rules and users with open metadata.
    • Constructor Summary

      Constructors 
      Constructor Description
      OrganizationManagement​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      OrganizationManagement​(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.
      OrganizationManagement​(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.
      OrganizationManagement​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, CommunityProfileRESTClient restClient, int maxPageSize)
      Create a new client that passes userId and password in each HTTP request.
      OrganizationManagement​(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
      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 a 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 externalSourceGUID, java.lang.String externalSourceName, java.lang.String actorProfileGUID)
      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 a named actor profile.
      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.
      • Methods inherited from class java.lang.Object

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