com.github.deinok.sakaiapi.models

Class Site

java.lang.Object

com.github.deinok.sakaiapi.models.abstracts.Entity

com.github.deinok.sakaiapi.models.Site

All Implemented Interfaces:

JsonSerializable, Serializable, Cloneable

public class Site
extends Entity
implements Serializable, Cloneable, JsonSerializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Site.SiteCollection

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	activeEdit
Date	createdDate
Boolean	customPageOrdered
String	description
Boolean	empty
String	entityId
String	entityTitle
String	htmlDescription
String	htmlShortDescription
URL	iconUrl
URL	iconUrlFull
String	id
URL	infoUrl
URL	infoUrlFull
Boolean	joinable
String	joinerRole
Date	lastModified
String	maintainRole
Date	modifiedDate
String	owner
Map<String,String>	props
String	providerGroupId
Boolean	published
Boolean	pubView
String	reference
String	shortDescription
List<Map<String,String>>	siteGroups
List<Map<String,String>>	siteGroupsList
Map<String,String>	siteOwner
List<SitePage>	sitePages
String	skin
Boolean	softlyDeleted
Date	softlyDeletedDate
String	title
String	type
List<String>	userRoles

Fields inherited from class com.github.deinok.sakaiapi.models.abstracts.Entity

entityReference, entityURL

Constructor Summary

Constructors

Constructor and Description

Site(String id, String entityReference, URL entityURL, Boolean activeEdit, Date createdDate, Boolean customPageOrdered, String description, Boolean empty, String htmlDescription, String htmlShortDescription, URL iconUrl, URL iconUrlFull, URL infoUrl, URL infoUrlFull, Boolean joinable, String joinerRole, Date lastModified, String maintainRole, Date modifiedDate, String owner, Map<String,String> props, String providerGroupId, Boolean pubView, Boolean published, String reference, String shortDescription, List<Map<String,String>> siteGroups, List<Map<String,String>> siteGroupsList, Map<String,String> siteOwner, List<SitePage> sitePages, String skin, Boolean softlyDeleted, Date softlyDeletedDate, String title, String type, List<String> userRoles, String entityId, String entityTitle)

Method Summary

Modifier and Type	Method and Description
Site	clone()
boolean	equals(Object object)
int	hashCode()
com.google.gson.JsonObject	toJsonObject() Creates the JsonObject of the Entity

Methods inherited from class java.lang.Object

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

Field Detail

activeEdit

@Nullable
public final Boolean activeEdit

createdDate

@NotNull
public final Date createdDate

customPageOrdered

@Nullable
public final Boolean customPageOrdered

description

@Nullable
public final String description

empty

@Nullable
public final Boolean empty

htmlDescription

@NotNull
public final String htmlDescription

htmlShortDescription

@NotNull
public final String htmlShortDescription

iconUrl

@Nullable
public final URL iconUrl

iconUrlFull

@Nullable
public final URL iconUrlFull

infoUrl

@Nullable
public final URL infoUrl

infoUrlFull

@Nullable
public final URL infoUrlFull

joinable

@Nullable
public final Boolean joinable

joinerRole

@Nullable
public final String joinerRole

lastModified

@NotNull
public final Date lastModified

maintainRole

@NotNull
public final String maintainRole

modifiedDate

@NotNull
public final Date modifiedDate

owner

@NotNull
public final String owner

props

@Nullable
public final Map<String,String> props

providerGroupId

@Nullable
public final String providerGroupId

pubView

@Nullable
public final Boolean pubView

published

@Nullable
public final Boolean published

reference

@NotNull
public final String reference

shortDescription

@Nullable
public final String shortDescription

siteGroups

@Nullable
public final List<Map<String,String>> siteGroups

siteGroupsList

@Nullable
public final List<Map<String,String>> siteGroupsList

siteOwner

@NotNull
public final Map<String,String> siteOwner

sitePages

@NotNull
public final List<SitePage> sitePages

skin

@Nullable
public final String skin

softlyDeleted

@Nullable
public final Boolean softlyDeleted

softlyDeletedDate

@Nullable
public final Date softlyDeletedDate

title

@NotNull
public final String title

type

@Nullable
public final String type

userRoles

@NotNull
public final List<String> userRoles

id

@Nullable
public final String id

entityId

@NotNull
public final String entityId

entityTitle

@NotNull
public final String entityTitle

Constructor Detail

Site

public Site(@Nullable
            String id,
            @NotNull
            String entityReference,
            @NotNull
            URL entityURL,
            @Nullable
            Boolean activeEdit,
            @NotNull
            Date createdDate,
            @Nullable
            Boolean customPageOrdered,
            @Nullable
            String description,
            @Nullable
            Boolean empty,
            @NotNull
            String htmlDescription,
            @NotNull
            String htmlShortDescription,
            @Nullable
            URL iconUrl,
            @Nullable
            URL iconUrlFull,
            @Nullable
            URL infoUrl,
            @Nullable
            URL infoUrlFull,
            @Nullable
            Boolean joinable,
            @Nullable
            String joinerRole,
            @NotNull
            Date lastModified,
            @NotNull
            String maintainRole,
            @NotNull
            Date modifiedDate,
            @NotNull
            String owner,
            @Nullable
            Map<String,String> props,
            @Nullable
            String providerGroupId,
            @Nullable
            Boolean pubView,
            @Nullable
            Boolean published,
            @NotNull
            String reference,
            @Nullable
            String shortDescription,
            @Nullable
            List<Map<String,String>> siteGroups,
            @Nullable
            List<Map<String,String>> siteGroupsList,
            @NotNull
            Map<String,String> siteOwner,
            @NotNull
            List<SitePage> sitePages,
            @Nullable
            String skin,
            @Nullable
            Boolean softlyDeleted,
            @Nullable
            Date softlyDeletedDate,
            @NotNull
            String title,
            @Nullable
            String type,
            @NotNull
            List<String> userRoles,
            @NotNull
            String entityId,
            @NotNull
            String entityTitle)

Method Detail

equals

public boolean equals(@Nullable
                      Object object)

Overrides:

equals in class Entity

hashCode

public int hashCode()

Overrides:

hashCode in class Entity

clone

@NotNull
public Site clone()
                     throws CloneNotSupportedException

Overrides:

clone in class Entity

Throws:

CloneNotSupportedException

toJsonObject

@NotNull
public com.google.gson.JsonObject toJsonObject()

Description copied from class: Entity

Creates the JsonObject of the Entity

Specified by:

toJsonObject in interface JsonSerializable

Overrides:

toJsonObject in class Entity

Returns:

The JsonObject