MoxtraBinder (eXo Moxtra :: Client 1.0.0-M1 API)

java.lang.Object
- org.exoplatform.moxtra.client.MoxtraBinder

Direct Known Subclasses:

MoxtraMeet
```
public class MoxtraBinder
extends Object
```
Moxtra binder as described in their REST API.
Created by The eXo Platform SAS

Version:

$Id: MoxtraBinder.java 00000 Feb 28, 2015 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`binderId` Binder ID.
`protected Date`	`createdTime`
`protected boolean`	`deleted`
`protected Boolean`	`isNew`
`protected String`	`name` Meet name, also known as binder name.
`protected Long`	`revision`
`protected String`	`thumbnailUrl`
`protected Date`	`updatedTime`
`static String`	`USER_STATUS_BOARD_INVITED` Invited user status in a binder.
`static String`	`USER_STATUS_BOARD_MEMBER` Creator user status in a binder.
`static String`	`USER_TYPE_BOARD_OWNER` Creator user type in a binder.
`static String`	`USER_TYPE_BOARD_READ_WRITE` Invited user type in a binder with read/writer permissions.
`protected List<MoxtraUser>`	`users` Binder users.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`MoxtraBinder()` New binder constructor.
`protected`	`MoxtraBinder(MoxtraBinder other)` Editor constructor.
	`MoxtraBinder(String binderId, String name, Long revision, Date createdTime, Date updatedTime)` Existing binder constructor (for reading from Binder REST API).
`protected`	`MoxtraBinder(String binderId, String name, Long revision, String thumbnailUrl, Date createdTime, Date updatedTime)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addUser(MoxtraUser user)`
`void`	`delete()` Mark this binder as such that should be deleted in Moxtra.
`void`	`editName(String newName)`
`MoxtraBinder`	`editor()` Return an editor instance for this binder.
`List<MoxtraUser>`	`getAddedUsers()`
`String`	`getBinderId()`
`Date`	`getCreatedTime()`
`String`	`getName()`
`List<MoxtraUser>`	`getRemovedUsers()`
`Long`	`getRevision()`
`String`	`getThumbnailUrl()`
`Date`	`getUpdatedTime()`
`List<MoxtraUser>`	`getUsers()`
`boolean`	`hasDeleted()` Answers is this binder should be deleted in Moxtra.
`boolean`	`hasNameChanged()`
`boolean`	`hasUsersAdded()`
`boolean`	`hasUsersRemoved()`
`boolean`	`isEditor()`
`boolean`	`isNew()` Answers is this a new binder (not yet saved) for Moxtra.
`void`	`removeUser(MoxtraUser user)`
`protected void`	`setBinderId(String binderId)`
`protected void`	`setCreatedTime(Date createdTime)`
`protected void`	`setName(String name)`
`protected void`	`setRevision(Long revision)`
`protected void`	`setThumbnailUrl(String url)`
`protected void`	`setUpdatedTime(Date updatedTime)`
`protected void`	`setUsers(List<MoxtraUser> users)` Set binder users.
`String`	`toString()`
`void`	`undelete()` Mark this binder as such that should not be deleted in Moxtra.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - USER_TYPE_BOARD_OWNER
```
public static final String USER_TYPE_BOARD_OWNER
```
    Creator user type in a binder.
    
    See Also:
    Constant Field Values
  - USER_TYPE_BOARD_READ_WRITE
```
public static final String USER_TYPE_BOARD_READ_WRITE
```
    Invited user type in a binder with read/writer permissions.
    
    See Also:
    Constant Field Values
  - USER_STATUS_BOARD_MEMBER
```
public static final String USER_STATUS_BOARD_MEMBER
```
    Creator user status in a binder.
    
    See Also:
    Constant Field Values
  - USER_STATUS_BOARD_INVITED
```
public static final String USER_STATUS_BOARD_INVITED
```
    Invited user status in a binder.
    
    See Also:
    Constant Field Values
  - binderId
```
protected String binderId
```
    Binder ID.
  - name
```
protected String name
```
    Meet name, also known as binder name.
  - revision
```
protected Long revision
```
  - thumbnailUrl
```
protected String thumbnailUrl
```
  - createdTime
```
protected Date createdTime
```
  - updatedTime
```
protected Date updatedTime
```
  - users
```
protected List<MoxtraUser> users
```
    Binder users. Should be initialized by setUsers(List).
  - isNew
```
protected final transient Boolean isNew
```
  - deleted
```
protected transient boolean deleted
```
- Constructor Detail
  - MoxtraBinder
```
protected MoxtraBinder(String binderId,
            String name,
            Long revision,
            String thumbnailUrl,
            Date createdTime,
            Date updatedTime)
```
  - MoxtraBinder
```
public MoxtraBinder()
```
    New binder constructor. For creating a new binder in Moxtra.
  - MoxtraBinder
```
public MoxtraBinder(String binderId,
            String name,
            Long revision,
            Date createdTime,
            Date updatedTime)
```
    Existing binder constructor (for reading from Binder REST API).
    
    Parameters:
    binderId -
    name -
    revision -
    createdTime -
    updatedTime -
  - MoxtraBinder
```
protected MoxtraBinder(MoxtraBinder other)
```
    Editor constructor.
    
    Parameters:
    other -
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - editor
```
public MoxtraBinder editor()
```
    Return an editor instance for this binder. If invoke this method on already editor instance then it will return itself. If invoke several times, the same editor instance will be returned. Editor exists as a singleton for a particular binder.
    
    Returns:
    MoxtraBinder edit instance
  - isNew
```
public boolean isNew()
```
    Answers is this a new binder (not yet saved) for Moxtra.
    
    Returns:
    boolean true if it is a new meet, false otherwise
  - hasDeleted
```
public boolean hasDeleted()
```
    Answers is this binder should be deleted in Moxtra.
    
    Returns:
    boolean true if meet should be deleted, false otherwise
  - delete
```
public void delete()
```
    Mark this binder as such that should be deleted in Moxtra.
  - undelete
```
public void undelete()
```
    Mark this binder as such that should not be deleted in Moxtra. It should be created or updated depending on isNew() result.
  - getBinderId
```
public String getBinderId()
```
    Returns:
    the binder id
  - getName
```
public String getName()
```
    Returns:
    the name
  - getRevision
```
public Long getRevision()
```
    Returns:
    the revision
  - getThumbnailUrl
```
public String getThumbnailUrl()
```
    Returns:
    the thumbnailUrl
  - getCreatedTime
```
public Date getCreatedTime()
```
    Returns:
    the createdTime
  - getUpdatedTime
```
public Date getUpdatedTime()
```
    Returns:
    the updatedTime
  - addUser
```
public void addUser(MoxtraUser user)
```
    Parameters:
    user -
  - removeUser
```
public void removeUser(MoxtraUser user)
```
    Parameters:
    user -
  - getUsers
```
public List<MoxtraUser> getUsers()
```
    Returns:
    the users
  - getAddedUsers
```
public List<MoxtraUser> getAddedUsers()
```
    Returns:
    the addedUsers
  - hasUsersAdded
```
public boolean hasUsersAdded()
```
  - getRemovedUsers
```
public List<MoxtraUser> getRemovedUsers()
```
    Returns:
    the removedUsers
  - hasUsersRemoved
```
public boolean hasUsersRemoved()
```
  - editName
```
public void editName(String newName)
```
  - hasNameChanged
```
public boolean hasNameChanged()
```
  - isEditor
```
public boolean isEditor()
```
  - setUsers
```
protected void setUsers(List<MoxtraUser> users)
```
    Set binder users.
    
    Parameters:
    users -
  - setBinderId
```
protected void setBinderId(String binderId)
```
    Parameters:
    String - the binder id to set
  - setName
```
protected void setName(String name)
```
    Parameters:
    name - the name to set
  - setRevision
```
protected void setRevision(Long revision)
```
    Parameters:
    revision - the revision to set
  - setThumbnailUrl
```
protected void setThumbnailUrl(String url)
```
    Parameters:
    String - the thumbnailUrl to set
  - setCreatedTime
```
protected void setCreatedTime(Date createdTime)
```
    Parameters:
    createdTime - the createdTime to set
  - setUpdatedTime
```
protected void setUpdatedTime(Date updatedTime)
```
    Parameters:
    updatedTime - the updatedTime to set

Class MoxtraBinder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_TYPE_BOARD_OWNER

USER_TYPE_BOARD_READ_WRITE

USER_STATUS_BOARD_MEMBER

USER_STATUS_BOARD_INVITED

binderId

name

revision

thumbnailUrl

createdTime

updatedTime

users

isNew

deleted

Constructor Detail

MoxtraBinder

MoxtraBinder

MoxtraBinder

MoxtraBinder

Method Detail

toString

editor

isNew

hasDeleted

delete

undelete

getBinderId

getName

getRevision

getThumbnailUrl

getCreatedTime

getUpdatedTime

addUser

removeUser

getUsers

getAddedUsers

hasUsersAdded

getRemovedUsers

hasUsersRemoved

editName

hasNameChanged

isEditor

setUsers

setBinderId

setName

setRevision

setThumbnailUrl

setCreatedTime

setUpdatedTime