com.tencentcloudapi.lcic.v20220817.models

Class DescribeDocumentsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lcic.v20220817.models.DescribeDocumentsRequest

public class DescribeDocumentsRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeDocumentsRequest()
DescribeDocumentsRequest(DescribeDocumentsRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String[]	getDocumentId() Get The courseware IDs.
String	getKeyword() Get The filename keyword.
Long	getLimit() Get The maximum number of records per page.
String	getOwner() Get The user ID of the courseware owner.
Long	getPage() Get The page to return records from.
Long[]	getPermission() Get The courseware access.
Long	getSchoolId() Get The school ID.
void	setDocumentId(String[] DocumentId) Set The courseware IDs.
void	setKeyword(String Keyword) Set The filename keyword.
void	setLimit(Long Limit) Set The maximum number of records per page.
void	setOwner(String Owner) Set The user ID of the courseware owner.
void	setPage(Long Page) Set The page to return records from.
void	setPermission(Long[] Permission) Set The courseware access.
void	setSchoolId(Long SchoolId) Set The school ID.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeDocumentsRequest

public DescribeDocumentsRequest()

DescribeDocumentsRequest

public DescribeDocumentsRequest(DescribeDocumentsRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getSchoolId

public Long getSchoolId()

Get The school ID.

Returns:

SchoolId The school ID.

setSchoolId

public void setSchoolId(Long SchoolId)

Set The school ID.

Parameters:

SchoolId - The school ID.

getPage

public Long getPage()

Get The page to return records from. Pagination starts from 1.

Returns:

Page The page to return records from. Pagination starts from 1.

setPage

public void setPage(Long Page)

Set The page to return records from. Pagination starts from 1.

Parameters:

Page - The page to return records from. Pagination starts from 1.

getLimit

public Long getLimit()

Get The maximum number of records per page. The value of this parameter cannot exceed `1000`.

Returns:

Limit The maximum number of records per page. The value of this parameter cannot exceed `1000`.

setLimit

public void setLimit(Long Limit)

Set The maximum number of records per page. The value of this parameter cannot exceed `1000`.

Parameters:

Limit - The maximum number of records per page. The value of this parameter cannot exceed `1000`.

getPermission

public Long[] getPermission()

Get The courseware access. [0]: The private courseware of the specified user (`Owner`) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including `Owner`) will be returned.

Returns:

Permission The courseware access. [0]: The private courseware of the specified user (`Owner`) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including `Owner`) will be returned.

setPermission

public void setPermission(Long[] Permission)

Set The courseware access. [0]: The private courseware of the specified user (`Owner`) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including `Owner`) will be returned.

Parameters:

Permission - The courseware access. [0]: The private courseware of the specified user (`Owner`) will be returned; [1]: The public courseware of the specified user will be returned; [0,1]: Both the private and public courseware of the specified user will be returned; [2]: The private courseware of the specified user and the public courseware of all users (including `Owner`) will be returned.

getOwner

public String getOwner()

Get The user ID of the courseware owner. If you do not specify this parameter, all courseware under the school ID will be returned.

Returns:

Owner The user ID of the courseware owner. If you do not specify this parameter, all courseware under the school ID will be returned.

setOwner

public void setOwner(String Owner)

Set The user ID of the courseware owner. If you do not specify this parameter, all courseware under the school ID will be returned.

Parameters:

Owner - The user ID of the courseware owner. If you do not specify this parameter, all courseware under the school ID will be returned.

getKeyword

public String getKeyword()

Get The filename keyword.

Returns:

Keyword The filename keyword.

setKeyword

public void setKeyword(String Keyword)

Set The filename keyword.

Parameters:

Keyword - The filename keyword.

getDocumentId

public String[] getDocumentId()

Get The courseware IDs. Non-existent IDs will be ignored.

Returns:

DocumentId The courseware IDs. Non-existent IDs will be ignored.

setDocumentId

public void setDocumentId(String[] DocumentId)

Set The courseware IDs. Non-existent IDs will be ignored.

Parameters:

DocumentId - The courseware IDs. Non-existent IDs will be ignored.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel