blackboard.ws.content
Class ContentFilter

java.lang.Object
  extended by blackboard.ws.content.ContentFilter

public class ContentFilter
extends java.lang.Object

The ContentFilter class provides search criteria to retrieve Content in the Content WS.

Since:
Bb 9.1

Constructor Summary
ContentFilter()
           
 
Method Summary
 java.lang.String getContentId()
           
 java.lang.String[] getExpansionData()
           
 int getFilterType()
           
 long getModifiedSinceDate()
           
 java.lang.String getTocId()
           
 java.lang.String getUserId()
           
 void setContentId(java.lang.String contentId)
          set content id as search criteria.
 void setExpansionData(java.lang.String[] expansionData)
          Expansion data is currently ignored.
 void setFilterType(int filterType)
          Specifies search criteria to load content items filterType : name : attributes to set 1 : GET_BY_CONTENTID : contentId 2 : GET_IMMEDIATE_CHILDREN_BY_CONTENTID : contentId 3 : GET_CHILDREN_BY_CONTENTID : contentId 4 : GET_ANCESTOR_BY_CONTENTID : contentId 5 : GET_ROOT_ENTRIES : (none) 6 : GET_REVIEWABLE_ENTRIES : (none) 7 : GET_ROOT_ENTRIES_BY_USERID : userId 8 : GET_MODIFIEDSINCE_BY_USERID : userId, modifiedSinceDate 9 : GET_CHILDREN_BY_CONTENTID_AND_USERID : contentId, userId 10 : GET_BY_TOCID : tocId NOTE: Results for some of the filters will not return fully populated ContentVO objects.
 void setModifiedSinceDate(long modifiedSinceDate)
          set content modified since date as search criteria
 void setTocId(java.lang.String tocId)
          set course toc id as search criteria
 void setUserId(java.lang.String userId)
          set user id as search criteria
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContentFilter

public ContentFilter()
Method Detail

getContentId

public java.lang.String getContentId()
Returns:
the contentId

setContentId

public void setContentId(java.lang.String contentId)
set content id as search criteria.

Parameters:
contentId - the contentIds to set

getUserId

public java.lang.String getUserId()
Returns:
the userId

setUserId

public void setUserId(java.lang.String userId)
set user id as search criteria

Parameters:
userId - the userId to set

getTocId

public java.lang.String getTocId()
Returns:
the tocId

setTocId

public void setTocId(java.lang.String tocId)
set course toc id as search criteria

Parameters:
tocId - the tocId to set

getModifiedSinceDate

public long getModifiedSinceDate()
Returns:
the modifiedSinceDate

setModifiedSinceDate

public void setModifiedSinceDate(long modifiedSinceDate)
set content modified since date as search criteria

Parameters:
modifiedSinceDate - the modifiedSinceDate to set

getFilterType

public int getFilterType()
Returns:
the filterType

setFilterType

public void setFilterType(int filterType)
Specifies search criteria to load content items

filterType : name : attributes to set 1 : GET_BY_CONTENTID : contentId 2 : GET_IMMEDIATE_CHILDREN_BY_CONTENTID : contentId 3 : GET_CHILDREN_BY_CONTENTID : contentId 4 : GET_ANCESTOR_BY_CONTENTID : contentId 5 : GET_ROOT_ENTRIES : (none) 6 : GET_REVIEWABLE_ENTRIES : (none) 7 : GET_ROOT_ENTRIES_BY_USERID : userId 8 : GET_MODIFIEDSINCE_BY_USERID : userId, modifiedSinceDate 9 : GET_CHILDREN_BY_CONTENTID_AND_USERID : contentId, userId 10 : GET_BY_TOCID : tocId NOTE: Results for some of the filters will not return fully populated ContentVO objects. Filter 6 (reviewable entries) will not include the body field Filter 7 (root entries by userid) will only return these fields: id, title, position, parent_id, reviewable, sequential, content-handler Filter 8 (modified-since-by-userid) will only return these fields: id, title, position, content handler, parent_id


getExpansionData

public java.lang.String[] getExpansionData()
Returns:
the expansionData

setExpansionData

public void setExpansionData(java.lang.String[] expansionData)
Expansion data is currently ignored. In future versions it may be used to add additional attributes without breaking the wsdl contract.

Parameters:
expansionData - the expansionData to set (For Future Use)


Copyright © 2012 Blackboard, Inc. All Rights Reserved.