Package com.smartsheet.api.models

Class Group

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<T>

com.smartsheet.api.models.NamedModel<java.lang.Long>

com.smartsheet.api.models.Group

public class Group
extends NamedModel<java.lang.Long>

Represents a Group Object.

See Also:

Managing groups

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Group.CreateGroupBuilder	A convenience class to make a Group object with the necessary fields to create the group by posting it to smartsheet.
static class	Group.UpdateGroupBuilder	A convenience class to update a Group object with the necessary fields to create the group by putting it to smartsheet.

Constructor Summary

Constructors

Constructor	Description
Group()	Constructors
Group(java.lang.Long id)

Method Summary

Modifier and Type	Method	Description
java.util.Date	getCreatedAt()
java.lang.String	getDescription()
java.util.List<GroupMember>	getMembers()
java.util.Date	getModifiedAt()
java.lang.String	getOwner()
java.lang.Long	getOwnerId()
Group	setCreatedAt(java.util.Date createdAt)
Group	setDescription(java.lang.String description)
Group	setMembers(java.util.List<GroupMember> members)
Group	setModifiedAt(java.util.Date modifiedAt)
Group	setName(java.lang.String name)	Provide an 'override' of setName (returns Group not NamedModel)
Group	setOwner(java.lang.String owner)
Group	setOwnerId(java.lang.Long ownerId)

Methods inherited from class com.smartsheet.api.models.NamedModel

getName

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Group

public Group()

Constructors

Group

public Group(java.lang.Long id)

Method Detail

setName

public Group setName(java.lang.String name)

Provide an 'override' of setName (returns Group not NamedModel)

Overrides:

setName in class NamedModel<java.lang.Long>

Parameters:

name - the new name

getDescription

public java.lang.String getDescription()

Returns:

the description of the group

setDescription

public Group setDescription(java.lang.String description)

Parameters:

description - the description to set

getOwner

public java.lang.String getOwner()

Returns:

the email address of the owner

setOwner

public Group setOwner(java.lang.String owner)

Parameters:

owner - the owner email address to set

getOwnerId

public java.lang.Long getOwnerId()

Returns:

the id of the owner of the group.

setOwnerId

public Group setOwnerId(java.lang.Long ownerId)

Parameters:

ownerId - the owner Id to set

getCreatedAt

public java.util.Date getCreatedAt()

Returns:

the createdAt Date

setCreatedAt

public Group setCreatedAt(java.util.Date createdAt)

Parameters:

createdAt - the createdAt Date to set

getModifiedAt

public java.util.Date getModifiedAt()

Returns:

the modifiedAt Date

setModifiedAt

public Group setModifiedAt(java.util.Date modifiedAt)

Parameters:

modifiedAt - the modifiedAt Date to set

getMembers

public java.util.List<GroupMember> getMembers()

Returns:

the List of Groups

setMembers

public Group setMembers(java.util.List<GroupMember> members)

Parameters:

members - the List of Users to set