Package org.apache.ofbiz.party.party

Class PartyServices

  • public class PartyServices
extends java.lang.Object
    Services for Party/Person/Group maintenance

    • Constructor Summary

      Constructors 
      Constructor Description
      PartyServices()  

    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static java.util.Map<java.lang.String,​java.lang.Object> createAffiliate​(DispatchContext ctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Create an Affiliate entity.
      static java.util.Map<java.lang.String,​java.lang.Object> createPartyGroup​(DispatchContext ctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Creates a PartyGroup.
      static java.util.Map<java.lang.String,​java.lang.Object> createPartyNote​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Add a PartyNote.
      static java.util.Map<java.lang.String,​java.lang.Object> createPerson​(DispatchContext ctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Creates a Person.
      static java.util.Map<java.lang.String,​java.lang.Object> createRoleType​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)  
      static java.util.Map<java.lang.String,​java.lang.Object> findParty​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Deprecated.
      static java.util.Map<java.lang.String,​java.lang.Object> findPartyById​(DispatchContext ctx, java.util.Map<java.lang.String,​java.lang.Object> context)
      Finds partyId(s) corresponding to a party reference, partyId or a GoodIdentification idValue
      static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromExactEmail​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Get the party object(s) from an e-mail address
      static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromExternalId​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Get the party object(s) from party externalId.
      static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromPartOfEmail​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)  
      static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromPartOfUserloginId​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Get the party object(s) from a user login ID
      static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromPartyGroup​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Get the party object(s) from party group name.
      static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromPerson​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Get the party object(s) from person information
      static java.lang.String getPartyId​(java.util.Map<java.lang.String,​? extends java.lang.Object> context)  
      static java.util.Map<java.lang.String,​java.lang.Object> getPerson​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)  
      static java.util.Map<java.lang.String,​java.lang.Object> importAddressMatchMapCsv​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)  
      static java.util.Map<java.lang.String,​java.lang.Object> importParty​(DispatchContext dctx, java.util.Map<java.lang.String,​java.lang.Object> context)  
      static java.util.Map<java.lang.String,​java.lang.Object> linkParty​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Changes the association of contact mechs, purposes, notes, orders and attributes from one party to another for the purpose of merging records together.
      static java.util.Map<java.lang.String,​java.lang.Object> performFindParty​(DispatchContext dctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)  
      static java.util.Map<java.lang.String,​java.lang.Object> setPartyStatus​(DispatchContext ctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Sets a party status.
      static java.util.Map<java.lang.String,​java.lang.Object> updateAffiliate​(DispatchContext ctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Updates an Affiliate.
      static java.util.Map<java.lang.String,​java.lang.Object> updatePartyGroup​(DispatchContext ctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Updates a PartyGroup.
      static java.util.Map<java.lang.String,​java.lang.Object> updatePerson​(DispatchContext ctx, java.util.Map<java.lang.String,​? extends java.lang.Object> context)
      Updates a Person.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PartyServices

        public PartyServices()

    • Method Detail

      • createPerson

        public static java.util.Map<java.lang.String,​java.lang.Object> createPerson​(DispatchContext ctx,
                                                                                  java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Creates a Person. If no partyId is specified a numeric partyId is retrieved from the Party sequence.
        Parameters:
        ctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • setPartyStatus

        public static java.util.Map<java.lang.String,​java.lang.Object> setPartyStatus​(DispatchContext ctx,
                                                                                    java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Sets a party status. security check: the status change must be defined in StatusValidChange.

      • updatePerson

        public static java.util.Map<java.lang.String,​java.lang.Object> updatePerson​(DispatchContext ctx,
                                                                                  java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Updates a Person.
        Parameters:
        ctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • createPartyGroup

        public static java.util.Map<java.lang.String,​java.lang.Object> createPartyGroup​(DispatchContext ctx,
                                                                                      java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Creates a PartyGroup. If no partyId is specified a numeric partyId is retrieved from the Party sequence.
        Parameters:
        ctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • updatePartyGroup

        public static java.util.Map<java.lang.String,​java.lang.Object> updatePartyGroup​(DispatchContext ctx,
                                                                                      java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Updates a PartyGroup.
        Parameters:
        ctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • createAffiliate

        public static java.util.Map<java.lang.String,​java.lang.Object> createAffiliate​(DispatchContext ctx,
                                                                                     java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Create an Affiliate entity.
        Parameters:
        ctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • updateAffiliate

        public static java.util.Map<java.lang.String,​java.lang.Object> updateAffiliate​(DispatchContext ctx,
                                                                                     java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Updates an Affiliate.
        Parameters:
        ctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • createPartyNote

        public static java.util.Map<java.lang.String,​java.lang.Object> createPartyNote​(DispatchContext dctx,
                                                                                     java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Add a PartyNote.
        Parameters:
        dctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • getPartiesFromExactEmail

        public static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromExactEmail​(DispatchContext dctx,
                                                                                              java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Get the party object(s) from an e-mail address
        Parameters:
        dctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • getPartiesFromPartOfEmail

        public static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromPartOfEmail​(DispatchContext dctx,
                                                                                               java.util.Map<java.lang.String,​? extends java.lang.Object> context)

      • getPartiesFromPartOfUserloginId

        public static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromPartOfUserloginId​(DispatchContext dctx,
                                                                                                     java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Get the party object(s) from a user login ID
        Parameters:
        dctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • getPartiesFromPerson

        public static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromPerson​(DispatchContext dctx,
                                                                                          java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Get the party object(s) from person information
        Parameters:
        dctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • getPartiesFromPartyGroup

        public static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromPartyGroup​(DispatchContext dctx,
                                                                                              java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Get the party object(s) from party group name.
        Parameters:
        dctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • getPartiesFromExternalId

        public static java.util.Map<java.lang.String,​java.lang.Object> getPartiesFromExternalId​(DispatchContext dctx,
                                                                                              java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Get the party object(s) from party externalId.
        Parameters:
        dctx - The DispatchContext that this service is operating in.
        context - Map containing the input parameters.
        Returns:
        Map with the result of the service, the output parameters.

      • getPerson

        public static java.util.Map<java.lang.String,​java.lang.Object> getPerson​(DispatchContext dctx,
                                                                               java.util.Map<java.lang.String,​? extends java.lang.Object> context)

      • createRoleType

        public static java.util.Map<java.lang.String,​java.lang.Object> createRoleType​(DispatchContext dctx,
                                                                                    java.util.Map<java.lang.String,​? extends java.lang.Object> context)

      • findParty

        @Deprecated
public static java.util.Map<java.lang.String,​java.lang.Object> findParty​(DispatchContext dctx,
                                                                               java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Deprecated.

      • performFindParty

        public static java.util.Map<java.lang.String,​java.lang.Object> performFindParty​(DispatchContext dctx,
                                                                                      java.util.Map<java.lang.String,​? extends java.lang.Object> context)

      • linkParty

        public static java.util.Map<java.lang.String,​java.lang.Object> linkParty​(DispatchContext dctx,
                                                                               java.util.Map<java.lang.String,​? extends java.lang.Object> context)
        Changes the association of contact mechs, purposes, notes, orders and attributes from one party to another for the purpose of merging records together. Flags the from party as disabled so it no longer appears in a search.
        Parameters:
        dctx - the dispatch context
        context - the context
        Returns:
        the result of the service execution

      • importAddressMatchMapCsv

        public static java.util.Map<java.lang.String,​java.lang.Object> importAddressMatchMapCsv​(DispatchContext dctx,
                                                                                              java.util.Map<java.lang.String,​? extends java.lang.Object> context)

      • getPartyId

        public static java.lang.String getPartyId​(java.util.Map<java.lang.String,​? extends java.lang.Object> context)

      • findPartyById

        public static java.util.Map<java.lang.String,​java.lang.Object> findPartyById​(DispatchContext ctx,
                                                                                   java.util.Map<java.lang.String,​java.lang.Object> context)
        Finds partyId(s) corresponding to a party reference, partyId or a GoodIdentification idValue
        Parameters:
        ctx - the dispatch context
        context - use to search with partyId or goodIdentification.idValue
        Returns:
        a GenericValue with a partyId and a List of complementary partyId found

      • importParty

        public static java.util.Map<java.lang.String,​java.lang.Object> importParty​(DispatchContext dctx,
                                                                                 java.util.Map<java.lang.String,​java.lang.Object> context)