Zimlet JavaScript API Reference - ZmDomain

Class ZmDomain


Extends ZmModel.

This class represents a domain.

Defined in: ZmDomainList.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmDomain(name, headerFlags)
Method Summary
Method Attributes Method Name and Description
 
addSubDomain(name, headerFlags)
Adds the sub-domain.
 
Gets the sub-domains.
 
Gets the sub-domain.
 
Gets the sub-domains.
<static>  
ZmDomain.sortCompare(a, b)
Compares two domains by name.
 
Returns a string representation of the object.
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmDomain(name, headerFlags)
Parameters:
{String} name
the name
{String} headerFlags
header flags (where domain was found)
Method Detail
{ZmDomain} addSubDomain(name, headerFlags)
Adds the sub-domain.
Defined in: ZmDomain.js.
Parameters:
{String} name
the name
{String} headerFlags
the header flags
Returns:
{ZmDomain} the newly created sub-domain

{Array} getSortedSubDomains()
Gets the sub-domains.
Defined in: ZmDomain.js.
Returns:
{Array} an array of ZmDomain objects (sorted)

{ZmDomain} getSubDomain(name)
Gets the sub-domain.
Defined in: ZmDomain.js.
Parameters:
{String} name
the name
Returns:
{ZmDomain} the sub-domain

getSubDomains()
Gets the sub-domains.
Defined in: ZmDomain.js.

<static> {int} ZmDomain.sortCompare(a, b)
Compares two domains by name.
Parameters:
{ZmDomain} a
the first domain
{ZmDomain} b
the second domain
Returns:
{int} 0 if the domains match; 1 if "a" is before "b"; -1 if "b" is before "a"

{String} toString()
Returns a string representation of the object.
Defined in: ZmDomain.js.
Returns:
{String} a string representation of the object

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:38 GMT-0400 (EDT)