Package edu.internet2.middleware.grouper.ws.coresoap

Class WsAttributeDefLookup

java.lang.Object
edu.internet2.middleware.grouper.ws.coresoap.WsAttributeDefLookup
All Implemented Interfaces:
GrouperWsToStringCompact
public class WsAttributeDefLookup extends Object implements GrouperWsToStringCompact
 Class to lookup an attribute def via web service
 
 developers make sure each setter calls this.clearAttributeDef();

  • Constructor Details

    • WsAttributeDefLookup

      public WsAttributeDefLookup()

    • WsAttributeDefLookup

      public WsAttributeDefLookup(String name1, String uuid1)
      Parameters:
      name1 -
      uuid1 -

    • WsAttributeDefLookup

      public WsAttributeDefLookup(String name1, String uuid1, String idIndex1)
      Parameters:
      name1 -
      uuid1 -
      idIndex1 -

  • Method Details

    • getIdIndex

      public String getIdIndex()
      integer ID for object
      Returns:
      the id

    • setIdIndex

      public void setIdIndex(String idIndex1)
      integer ID for object
      Parameters:
      idIndex1 -

    • blank

      public boolean blank()
      see if blank
      Returns:
      true if blank

    • hasData

      public boolean hasData()
      see if this attributeDef lookup has data
      Returns:
      true if it has data

    • retrieveAttributeDef

      public AttributeDef retrieveAttributeDef()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the attributeDef

    • retrievePITAttributeDefs

      public Set<PITAttributeDef> retrievePITAttributeDefs()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the pit attributeDefs

    • retrieveAttributeDefFindResult

      public WsAttributeDefLookup.AttributeDefFindResult retrieveAttributeDefFindResult()
       
 Note: this is not a javabean property because we dont want it in the web service
      Returns:
      the attributeDefFindResult, this is never null

    • toString

      public String toString()
      make sure this is an explicit toString
      Overrides:
      toString in class Object

    • retrieveAttributeDefIfNeeded

      public void retrieveAttributeDefIfNeeded(GrouperSession grouperSession)
      retrieve the attributeDef for this lookup if not looked up yet. pass in a grouper session
      Parameters:
      grouperSession -

    • retrieveAttributeDefIfNeeded

      public AttributeDef retrieveAttributeDefIfNeeded(GrouperSession grouperSession, String invalidQueryReason) throws WsInvalidQueryException
      retrieve the attributeDef for this lookup if not looked up yet. pass in a grouper session
      Parameters:
      grouperSession -
      invalidQueryReason - is the text to go in the WsInvalidQueryException
      Returns:
      the attributeDef
      Throws:
      WsInvalidQueryException - if there is a problem, and if the invalidQueryReason is set

    • retrievePITAttributeDefsIfNeeded

      public Set<PITAttributeDef> retrievePITAttributeDefsIfNeeded(String invalidQueryReason, Timestamp pointInTimeFrom, Timestamp pointInTimeTo) throws WsInvalidQueryException
      retrieve the pit attribute defs for this lookup if not looked up yet.
      Parameters:
      invalidQueryReason - is the text to go in the WsInvalidQueryException
      pointInTimeFrom -
      pointInTimeTo -
      Returns:
      the pit attribute def
      Throws:
      WsInvalidQueryException - if there is a problem, and if the invalidQueryReason is set

    • getUuid

      public String getUuid()
      uuid of the attributeDef to find
      Returns:
      the uuid

    • setUuid

      public void setUuid(String uuid1)
      uuid of the attributeDef to find
      Parameters:
      uuid1 - the uuid to set

    • getName

      public String getName()
      name of the attributeDef to find (includes stems, e.g. stem1:stem2:attributeDef
      Returns:
      the theName

    • setName

      public void setName(String theName)
      name of the attributeDef to find (includes stems, e.g. stem1:stem2:attributeDef
      Parameters:
      theName - the theName to set

    • convertToAttributeDefIds

      public static Set<String> convertToAttributeDefIds(GrouperSession grouperSession, WsAttributeDefLookup[] wsAttributeDefLookups, StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, Timestamp pointInTimeFrom, Timestamp pointInTimeTo)
      convert attributeDef lookups to attributeDef ids
      Parameters:
      grouperSession -
      wsAttributeDefLookups -
      errorMessage -
      attributeDefType -
      usePIT -
      pointInTimeFrom -
      pointInTimeTo -
      lookupCount - is an array of size one int where 1 will be added if there are records, and no change if not
      Returns:
      the attributeDef ids

    • convertToAttributeDefIds

      public static Set<String> convertToAttributeDefIds(GrouperSession grouperSession, WsAttributeDefLookup[] wsAttributeDefLookups, StringBuilder errorMessage, AttributeDefType attributeDefType, boolean usePIT, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, int[] lookupCount)
      convert attributeDef lookups to attributeDef ids
      Parameters:
      grouperSession -
      wsAttributeDefLookups -
      errorMessage -
      attributeDefType -
      usePIT -
      pointInTimeFrom -
      pointInTimeTo -
      lookupCount - is an array of size one int where 1 will be added if there are records, and no change if not
      Returns:
      the attributeDef ids

    • toStringCompact

      public String toStringCompact()
      make sure this is an explicit toString
      Specified by:
      toStringCompact in interface GrouperWsToStringCompact
      Returns:
      return a compact to string