edu.internet2.middleware.grouper.pit
Class PITMember

java.lang.Object
  extended by edu.internet2.middleware.grouper.GrouperAPI
      extended by edu.internet2.middleware.grouper.pit.GrouperPIT
          extended by edu.internet2.middleware.grouper.pit.PITMember
All Implemented Interfaces:
HibGrouperLifecycle, Hib3GrouperVersioned, GrouperCloneable, GrouperUtil.FieldValuable, Serializable, org.hibernate.classic.Lifecycle

public class PITMember
extends GrouperPIT
implements Hib3GrouperVersioned

Author:
shilen $Id$
See Also:
Serialized Form

Field Summary
static String COLUMN_CONTEXT_ID
          Context id links together multiple operations into one high level action
static String COLUMN_HIBERNATE_VERSION_NUMBER
          hibernate version
static String COLUMN_ID
          db id for this row
static String COLUMN_SOURCE_ID
          column
static String COLUMN_SUBJECT_ID
          subject id
static String COLUMN_SUBJECT_IDENTIFIER0
          subjectIdentifier0
static String COLUMN_SUBJECT_SOURCE
          subject source
static String COLUMN_SUBJECT_TYPE
          subject type
static String FIELD_CONTEXT_ID
          constant for field name for: contextId
static String FIELD_ID
          constant for field name for: id
static String FIELD_SOURCE_ID
          constant for field name for: sourceId
static String FIELD_SUBJECT_ID
          constant for field name for: subjectId
static String FIELD_SUBJECT_IDENTIFIER0
          constant for field name for: subjectIdentifier0
static String FIELD_SUBJECT_SOURCE
          constant for field name for: subjectSource
static String FIELD_SUBJECT_TYPE
          constant for field name for: subjectType
static String TABLE_GROUPER_PIT_MEMBERS
          name of the table in the database.
 
Fields inherited from class edu.internet2.middleware.grouper.pit.GrouperPIT
COLUMN_ACTIVE, COLUMN_END_TIME, COLUMN_START_TIME, FIELD_ACTIVE_DB, FIELD_END_TIME_DB, FIELD_START_TIME_DB
 
Fields inherited from class edu.internet2.middleware.grouper.GrouperAPI
FIELD_DB_VERSION, FIELD_HIBERNATE_VERSION_NUMBER, INITIAL_VERSION_NUMBER
 
Fields inherited from interface org.hibernate.classic.Lifecycle
NO_VETO, VETO
 
Constructor Summary
PITMember()
           
 
Method Summary
 GrouperAPI clone()
          deep clone the fields in this object
 void delete()
          delete this object
 String getContextId()
           
 Set<PITGroup> getGroups(String fieldSourceId, String scope, PITStem pitStem, Stem.Scope stemScope, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, QueryOptions queryOptions)
           
static Set<PITGroup> getGroups(String memberSourceId, String fieldSourceId, String scope, PITStem pitStem, Stem.Scope stemScope, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, QueryOptions queryOptions)
           
static Set<PITGroup> getGroups(String memberSourceId, String fieldSourceId, String scope, Stem stem, Stem.Scope stemScope, Timestamp pointInTimeFrom, Timestamp pointInTimeTo, QueryOptions queryOptions)
           
 String getId()
           
 String getSourceId()
           
 String getSubjectId()
           
 String getSubjectIdentifier0()
           
 String getSubjectSourceId()
           
 String getSubjectTypeId()
           
 void saveOrUpdate()
          save or update this object
 void setContextId(String contextId)
          set context id
 void setId(String id)
          set id
 void setSourceId(String sourceId)
          set source id
 void setSubjectId(String subjectId)
          Set subjectId
 void setSubjectIdentifier0(String subjectIdentifier0)
          Set subjectIdentifier0
 void setSubjectSourceId(String subjectSourceId)
          Set subjectSourceId
 void setSubjectTypeId(String subjectTypeId)
          Set subjectTypeId
 
Methods inherited from class edu.internet2.middleware.grouper.pit.GrouperPIT
getActiveDb, getEndTime, getEndTimeDb, getStartTime, getStartTimeDb, isActive, setActiveDb, setEndTimeDb, setStartTimeDb
 
Methods inherited from class edu.internet2.middleware.grouper.GrouperAPI
dbVersion, dbVersionClear, dbVersionDifferentFields, dbVersionIsDifferent, dbVersionReset, fieldValue, getHibernateVersionNumber, onDelete, onLoad, onPostDelete, onPostSave, onPostUpdate, onPreDelete, onPreSave, onPreUpdate, onSave, onUpdate, setHibernateVersionNumber
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COLUMN_ID

public static final String COLUMN_ID
db id for this row

See Also:
Constant Field Values

COLUMN_CONTEXT_ID

public static final String COLUMN_CONTEXT_ID
Context id links together multiple operations into one high level action

See Also:
Constant Field Values

COLUMN_SUBJECT_ID

public static final String COLUMN_SUBJECT_ID
subject id

See Also:
Constant Field Values

COLUMN_SUBJECT_IDENTIFIER0

public static final String COLUMN_SUBJECT_IDENTIFIER0
subjectIdentifier0

See Also:
Constant Field Values

COLUMN_SUBJECT_SOURCE

public static final String COLUMN_SUBJECT_SOURCE
subject source

See Also:
Constant Field Values

COLUMN_SUBJECT_TYPE

public static final String COLUMN_SUBJECT_TYPE
subject type

See Also:
Constant Field Values

COLUMN_HIBERNATE_VERSION_NUMBER

public static final String COLUMN_HIBERNATE_VERSION_NUMBER
hibernate version

See Also:
Constant Field Values

COLUMN_SOURCE_ID

public static final String COLUMN_SOURCE_ID
column

See Also:
Constant Field Values

FIELD_SOURCE_ID

public static final String FIELD_SOURCE_ID
constant for field name for: sourceId

See Also:
Constant Field Values

FIELD_CONTEXT_ID

public static final String FIELD_CONTEXT_ID
constant for field name for: contextId

See Also:
Constant Field Values

FIELD_ID

public static final String FIELD_ID
constant for field name for: id

See Also:
Constant Field Values

FIELD_SUBJECT_ID

public static final String FIELD_SUBJECT_ID
constant for field name for: subjectId

See Also:
Constant Field Values

FIELD_SUBJECT_SOURCE

public static final String FIELD_SUBJECT_SOURCE
constant for field name for: subjectSource

See Also:
Constant Field Values

FIELD_SUBJECT_IDENTIFIER0

public static final String FIELD_SUBJECT_IDENTIFIER0
constant for field name for: subjectIdentifier0

See Also:
Constant Field Values

FIELD_SUBJECT_TYPE

public static final String FIELD_SUBJECT_TYPE
constant for field name for: subjectType

See Also:
Constant Field Values

TABLE_GROUPER_PIT_MEMBERS

public static final String TABLE_GROUPER_PIT_MEMBERS
name of the table in the database.

See Also:
Constant Field Values
Constructor Detail

PITMember

public PITMember()
Method Detail

getSourceId

public String getSourceId()
Returns:
source id

setSourceId

public void setSourceId(String sourceId)
set source id

Parameters:
sourceId -

clone

public GrouperAPI clone()
Description copied from class: GrouperAPI
deep clone the fields in this object

Specified by:
clone in interface GrouperCloneable
Specified by:
clone in class GrouperAPI
Returns:
the clone of the object
See Also:
GrouperAPI.clone()

getContextId

public String getContextId()
Returns:
context id

setContextId

public void setContextId(String contextId)
set context id

Parameters:
contextId -

getId

public String getId()
Returns:
id

setId

public void setId(String id)
set id

Parameters:
id -

getSubjectId

public String getSubjectId()
Returns:
subjectId

setSubjectId

public void setSubjectId(String subjectId)
Set subjectId

Parameters:
subjectId -

getSubjectSourceId

public String getSubjectSourceId()
Returns:
subjectSourceId

setSubjectSourceId

public void setSubjectSourceId(String subjectSourceId)
Set subjectSourceId

Parameters:
subjectSourceId -

getSubjectIdentifier0

public String getSubjectIdentifier0()
Returns:
subjectIdentifier0

setSubjectIdentifier0

public void setSubjectIdentifier0(String subjectIdentifier0)
Set subjectIdentifier0

Parameters:
subjectIdentifier0 -

getSubjectTypeId

public String getSubjectTypeId()
Returns:
subjectType

setSubjectTypeId

public void setSubjectTypeId(String subjectTypeId)
Set subjectTypeId

Parameters:
subjectTypeId -

saveOrUpdate

public void saveOrUpdate()
save or update this object


delete

public void delete()
delete this object


getGroups

public Set<PITGroup> getGroups(String fieldSourceId,
                               String scope,
                               PITStem pitStem,
                               Stem.Scope stemScope,
                               Timestamp pointInTimeFrom,
                               Timestamp pointInTimeTo,
                               QueryOptions queryOptions)
Parameters:
fieldSourceId - specifies the field id. This is required.
scope - is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
pitStem - is the stem to check in, or null if all
stemScope - is if in this stem, or in any stem underneath. You must pass stemScope if you pass a stem
pointInTimeFrom - the start of the range of the point in time query. This is optional.
pointInTimeTo - the end of the range of the point in time query. This is optional. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range.
queryOptions - optional query options.
Returns:
Set of PITGroup

getGroups

public static Set<PITGroup> getGroups(String memberSourceId,
                                      String fieldSourceId,
                                      String scope,
                                      PITStem pitStem,
                                      Stem.Scope stemScope,
                                      Timestamp pointInTimeFrom,
                                      Timestamp pointInTimeTo,
                                      QueryOptions queryOptions)
Parameters:
memberSourceId - specifies the member id. This is required.
fieldSourceId - specifies the field id. This is required.
scope - is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
pitStem - is the stem to check in, or null if all
stemScope - is if in this stem, or in any stem underneath. You must pass stemScope if you pass a stem
pointInTimeFrom - the start of the range of the point in time query. This is optional.
pointInTimeTo - the end of the range of the point in time query. This is optional. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range.
queryOptions - optional query options.
Returns:
Set of PITGroup

getGroups

public static Set<PITGroup> getGroups(String memberSourceId,
                                      String fieldSourceId,
                                      String scope,
                                      Stem stem,
                                      Stem.Scope stemScope,
                                      Timestamp pointInTimeFrom,
                                      Timestamp pointInTimeTo,
                                      QueryOptions queryOptions)
Parameters:
memberSourceId - specifies the member id. This is required.
fieldSourceId - specifies the field id. This is required.
scope - is a DB pattern that will have % appended to it, or null for all. e.g. school:whatever:parent:
stem - is the stem to check in, or null if all
stemScope - is if in this stem, or in any stem underneath. You must pass stemScope if you pass a stem
pointInTimeFrom - the start of the range of the point in time query. This is optional.
pointInTimeTo - the end of the range of the point in time query. This is optional. If this is the same as pointInTimeFrom, then the query will be done at a single point in time rather than a range.
queryOptions - optional query options.
Returns:
Set of PITGroup