blackboard.admin.data
Interface IAdminObject

All Superinterfaces:
IBbObject, Identifiable
All Known Subinterfaces:
IMembership
All Known Implementing Classes:
AdminCategory, AdminCourse, AdminCourseCourse, AdminObject, CourseCategory, CourseCategoryMembership, CourseSite, DataSource, DataSourceObjectCount, Enrollment, Membership, ObserverAssociation, Organization, OrganizationCategory, OrganizationCategoryMembership, OrganizationMembership, Person, StaffAssignment

public interface IAdminObject
extends IBbObject

The IAdminObject represents the interface to be used for data objects of the admin level package.

Since:
Bb 6.0

Nested Class Summary
static class IAdminObject.RecStatus
          Inner class devoted to explicit typing for available i_rec_status settings for Admin objects.
static class IAdminObject.RowStatus
          Inner class devoted to explicit typing for available status settings for Admin objects.
 
Method Summary
 java.lang.String getDataSourceBatchUid()
          Returns the data source batch_uid of this IAdminObject
 Id getDataSourceId()
          Returns the data source Id associated with this IAdminObject.
 IAdminObject.RecStatus getRecStatus()
          Returns the record status of this IAdminObject
 IAdminObject.RowStatus getRowStatus()
          Returns the row status of this IAdminObject
 void setDataSourceBatchUid(java.lang.String batchUid)
          Sets the data source batch_uid of this IAdminObject
 void setDataSourceId(Id iDataSourceId)
          Sets the data source Id value for this IAdminObject.
 void setRecStatus(IAdminObject.RecStatus eRecStatus)
          Sets the record status of this IAdminObject
 void setRowStatus(IAdminObject.RowStatus eRowStatus)
          Sets the row status of this IAdminObject
 void validate()
          Validates the contents of this IAdminObject.
 
Methods inherited from interface blackboard.data.IBbObject
getBbAttributes, getCreatedDate, getDataType, getModifiedDate, setCreatedDate, setModifiedDate
 
Methods inherited from interface blackboard.data.Identifiable
getId, setId
 

Method Detail

getRowStatus

IAdminObject.RowStatus getRowStatus()
Returns the row status of this IAdminObject

Returns:
a status value as defined in IAdminObject.RowStatus
See Also:
IAdminObject.RowStatus

setRowStatus

void setRowStatus(IAdminObject.RowStatus eRowStatus)
Sets the row status of this IAdminObject

Parameters:
eRowStatus - a status value as defined in IAdminObject.RowStatus
See Also:
IAdminObject.RowStatus

getRecStatus

IAdminObject.RecStatus getRecStatus()
Returns the record status of this IAdminObject

Returns:
a status value as defined in IAdminObject.RecStatus
See Also:
IAdminObject.RecStatus

setRecStatus

void setRecStatus(IAdminObject.RecStatus eRecStatus)
Sets the record status of this IAdminObject

Parameters:
eRecStatus - a status value as defined in IAdminObject.RecStatus
See Also:
IAdminObject.RecStatus

getDataSourceBatchUid

java.lang.String getDataSourceBatchUid()
Returns the data source batch_uid of this IAdminObject

Returns:
data source batch_uid for this IAdminObject

setDataSourceBatchUid

void setDataSourceBatchUid(java.lang.String batchUid)
Sets the data source batch_uid of this IAdminObject

Parameters:
batchUid - a data source batch_uid value for this IAdminObject

getDataSourceId

Id getDataSourceId()
Returns the data source Id associated with this IAdminObject.

Returns:
data source Id value for this Course

setDataSourceId

void setDataSourceId(Id iDataSourceId)
Sets the data source Id value for this IAdminObject.

Parameters:
iDataSourceId - a data source Id value to use for this Course

validate

void validate()
              throws ValidationException
Validates the contents of this IAdminObject. Internal consistency checks are also performed.

Specified by:
validate in interface IBbObject
Throws:
ValidationException - if validation of this object fails


Copyright © 2012 Blackboard, Inc. All Rights Reserved.