com.edustructures.sifworks
Class SubscriptionOptions

java.lang.Object
  extended by com.edustructures.sifworks.ProvisioningOptions
      extended by com.edustructures.sifworks.SubscriptionOptions

public class SubscriptionOptions
extends ProvisioningOptions

Encapsulates the set of Subscription options supported by a given subscriber


Constructor Summary
SubscriptionOptions()
          Creates an instance of SubscriptionOptions that supports the default SIF Context
SubscriptionOptions(SIFContext... contexts)
          Creates an instance of SubscriptionOptions that only supports the given set of SIFContextx.
 
Method Summary
 boolean getSendSIFSubscribe()
          If ADK managed provisioining is in effect, this flag controls whether a SIF_Subscribe message is sent when connecting to the ZIS in legacy mode.
 void setSendSIFSubscribe(boolean flag)
          If ADK managed provisioining is in effect, this flag controls whether a SIF_Subscribe message is sent when connecting to the ZIS in legacy mode.
 
Methods inherited from class com.edustructures.sifworks.ProvisioningOptions
addSupportedContext, getSupportedContexts, supportsContext
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubscriptionOptions

public SubscriptionOptions()
Creates an instance of SubscriptionOptions that supports the default SIF Context


SubscriptionOptions

public SubscriptionOptions(SIFContext... contexts)
Creates an instance of SubscriptionOptions that only supports the given set of SIFContextx. If the set of contexts given does not include the default SIF context, the default context will not be supported by this Subscriber

Parameters:
contexts -
Method Detail

getSendSIFSubscribe

public boolean getSendSIFSubscribe()
If ADK managed provisioining is in effect, this flag controls whether a SIF_Subscribe message is sent when connecting to the ZIS in legacy mode.

The default value of this property is True

Returns:
True if a SIF_Subscribe message should be sent
See Also:
AgentProperties.getProvisionInLegacyMode()

setSendSIFSubscribe

public void setSendSIFSubscribe(boolean flag)
If ADK managed provisioining is in effect, this flag controls whether a SIF_Subscribe message is sent when connecting to the ZIS in legacy mode.

The default value of this property is True

Parameters:
flag -
See Also:
AgentProperties.getProvisionInLegacyMode()


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.