Changes since
the last release

com.ebay.soap.eBLBaseComponents
Class ApiAccessRuleType

java.lang.Object
  extended by com.ebay.soap.eBLBaseComponents.ApiAccessRuleType
All Implemented Interfaces:
Serializable

public class ApiAccessRuleType
extends Object
implements Serializable

This type is used by the ApiAccessRule container that is returned in the GetApiAccessRules call response. An ApiAccessRule container will be returned for every Trading API call that the user/application has used. The ApiAccessRule container consists of hourly, daily, and periodic call limits for the call, the total number of times the call was used, and other information about usage of the call.

Java class for ApiAccessRuleType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ApiAccessRuleType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="CallName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CountsTowardAggregate" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="DailyHardLimit" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="DailySoftLimit" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="DailyUsage" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="HourlyHardLimit" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="HourlySoftLimit" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="HourlyUsage" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="Period" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="PeriodicHardLimit" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="PeriodicSoftLimit" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="PeriodicUsage" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="PeriodicStartDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="ModTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="RuleCurrentStatus" type="{urn:ebay:apis:eBLBaseComponents}AccessRuleCurrentStatusCodeType" minOccurs="0"/>
         <element name="RuleStatus" type="{urn:ebay:apis:eBLBaseComponents}AccessRuleStatusCodeType" minOccurs="0"/>
         <any/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Field Summary
protected  List<Object> any
           
protected  String callName
           
protected  Boolean countsTowardAggregate
           
protected  Long dailyHardLimit
           
protected  Long dailySoftLimit
           
protected  Long dailyUsage
           
protected  Long hourlyHardLimit
           
protected  Long hourlySoftLimit
           
protected  Long hourlyUsage
           
protected  Calendar modTime
           
protected  Integer period
           
protected  Long periodicHardLimit
           
protected  Long periodicSoftLimit
           
protected  Calendar periodicStartDate
           
protected  Long periodicUsage
           
protected  AccessRuleCurrentStatusCodeType ruleCurrentStatus
           
protected  AccessRuleStatusCodeType ruleStatus
           
 
Constructor Summary
ApiAccessRuleType()
           
 
Method Summary
protected  List<Object> _getAny()
           
 Object[] getAny()
           
 Object getAny(int idx)
           
 int getAnyLength()
           
 String getCallName()
          Gets the value of the callName property.
 Long getDailyHardLimit()
          Gets the value of the dailyHardLimit property.
 Long getDailySoftLimit()
          Gets the value of the dailySoftLimit property.
 Long getDailyUsage()
          Gets the value of the dailyUsage property.
 Long getHourlyHardLimit()
          Gets the value of the hourlyHardLimit property.
 Long getHourlySoftLimit()
          Gets the value of the hourlySoftLimit property.
 Long getHourlyUsage()
          Gets the value of the hourlyUsage property.
 Calendar getModTime()
          Gets the value of the modTime property.
 Integer getPeriod()
          Gets the value of the period property.
 Long getPeriodicHardLimit()
          Gets the value of the periodicHardLimit property.
 Long getPeriodicSoftLimit()
          Gets the value of the periodicSoftLimit property.
 Calendar getPeriodicStartDate()
          Gets the value of the periodicStartDate property.
 Long getPeriodicUsage()
          Gets the value of the periodicUsage property.
 AccessRuleCurrentStatusCodeType getRuleCurrentStatus()
          Gets the value of the ruleCurrentStatus property.
 AccessRuleStatusCodeType getRuleStatus()
          Gets the value of the ruleStatus property.
 Boolean isCountsTowardAggregate()
          Gets the value of the countsTowardAggregate property.
 Object setAny(int idx, Object value)
           
 void setAny(Object[] values)
           
 void setCallName(String value)
          Sets the value of the callName property.
 void setCountsTowardAggregate(Boolean value)
          Sets the value of the countsTowardAggregate property.
 void setDailyHardLimit(Long value)
          Sets the value of the dailyHardLimit property.
 void setDailySoftLimit(Long value)
          Sets the value of the dailySoftLimit property.
 void setDailyUsage(Long value)
          Sets the value of the dailyUsage property.
 void setHourlyHardLimit(Long value)
          Sets the value of the hourlyHardLimit property.
 void setHourlySoftLimit(Long value)
          Sets the value of the hourlySoftLimit property.
 void setHourlyUsage(Long value)
          Sets the value of the hourlyUsage property.
 void setModTime(Calendar value)
          Sets the value of the modTime property.
 void setPeriod(Integer value)
          Sets the value of the period property.
 void setPeriodicHardLimit(Long value)
          Sets the value of the periodicHardLimit property.
 void setPeriodicSoftLimit(Long value)
          Sets the value of the periodicSoftLimit property.
 void setPeriodicStartDate(Calendar value)
          Sets the value of the periodicStartDate property.
 void setPeriodicUsage(Long value)
          Sets the value of the periodicUsage property.
 void setRuleCurrentStatus(AccessRuleCurrentStatusCodeType value)
          Sets the value of the ruleCurrentStatus property.
 void setRuleStatus(AccessRuleStatusCodeType value)
          Sets the value of the ruleStatus property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

callName

protected String callName

countsTowardAggregate

protected Boolean countsTowardAggregate

dailyHardLimit

protected Long dailyHardLimit

dailySoftLimit

protected Long dailySoftLimit

dailyUsage

protected Long dailyUsage

hourlyHardLimit

protected Long hourlyHardLimit

hourlySoftLimit

protected Long hourlySoftLimit

hourlyUsage

protected Long hourlyUsage

period

protected Integer period

periodicHardLimit

protected Long periodicHardLimit

periodicSoftLimit

protected Long periodicSoftLimit

periodicUsage

protected Long periodicUsage

periodicStartDate

protected Calendar periodicStartDate

modTime

protected Calendar modTime

ruleCurrentStatus

protected AccessRuleCurrentStatusCodeType ruleCurrentStatus

ruleStatus

protected AccessRuleStatusCodeType ruleStatus

any

protected List<Object> any
Constructor Detail

ApiAccessRuleType

public ApiAccessRuleType()
Method Detail

getCallName

public String getCallName()
Gets the value of the callName property.

Returns:
possible object is String

setCallName

public void setCallName(String value)
Sets the value of the callName property.

Parameters:
value - allowed object is String

isCountsTowardAggregate

public Boolean isCountsTowardAggregate()
Gets the value of the countsTowardAggregate property.

Returns:
possible object is Boolean

setCountsTowardAggregate

public void setCountsTowardAggregate(Boolean value)
Sets the value of the countsTowardAggregate property.

Parameters:
value - allowed object is Boolean

getDailyHardLimit

public Long getDailyHardLimit()
Gets the value of the dailyHardLimit property.

Returns:
possible object is Long

setDailyHardLimit

public void setDailyHardLimit(Long value)
Sets the value of the dailyHardLimit property.

Parameters:
value - allowed object is Long

getDailySoftLimit

public Long getDailySoftLimit()
Gets the value of the dailySoftLimit property.

Returns:
possible object is Long

setDailySoftLimit

public void setDailySoftLimit(Long value)
Sets the value of the dailySoftLimit property.

Parameters:
value - allowed object is Long

getDailyUsage

public Long getDailyUsage()
Gets the value of the dailyUsage property.

Returns:
possible object is Long

setDailyUsage

public void setDailyUsage(Long value)
Sets the value of the dailyUsage property.

Parameters:
value - allowed object is Long

getHourlyHardLimit

public Long getHourlyHardLimit()
Gets the value of the hourlyHardLimit property.

Returns:
possible object is Long

setHourlyHardLimit

public void setHourlyHardLimit(Long value)
Sets the value of the hourlyHardLimit property.

Parameters:
value - allowed object is Long

getHourlySoftLimit

public Long getHourlySoftLimit()
Gets the value of the hourlySoftLimit property.

Returns:
possible object is Long

setHourlySoftLimit

public void setHourlySoftLimit(Long value)
Sets the value of the hourlySoftLimit property.

Parameters:
value - allowed object is Long

getHourlyUsage

public Long getHourlyUsage()
Gets the value of the hourlyUsage property.

Returns:
possible object is Long

setHourlyUsage

public void setHourlyUsage(Long value)
Sets the value of the hourlyUsage property.

Parameters:
value - allowed object is Long

getPeriod

public Integer getPeriod()
Gets the value of the period property.

Returns:
possible object is Integer

setPeriod

public void setPeriod(Integer value)
Sets the value of the period property.

Parameters:
value - allowed object is Integer

getPeriodicHardLimit

public Long getPeriodicHardLimit()
Gets the value of the periodicHardLimit property.

Returns:
possible object is Long

setPeriodicHardLimit

public void setPeriodicHardLimit(Long value)
Sets the value of the periodicHardLimit property.

Parameters:
value - allowed object is Long

getPeriodicSoftLimit

public Long getPeriodicSoftLimit()
Gets the value of the periodicSoftLimit property.

Returns:
possible object is Long

setPeriodicSoftLimit

public void setPeriodicSoftLimit(Long value)
Sets the value of the periodicSoftLimit property.

Parameters:
value - allowed object is Long

getPeriodicUsage

public Long getPeriodicUsage()
Gets the value of the periodicUsage property.

Returns:
possible object is Long

setPeriodicUsage

public void setPeriodicUsage(Long value)
Sets the value of the periodicUsage property.

Parameters:
value - allowed object is Long

getPeriodicStartDate

public Calendar getPeriodicStartDate()
Gets the value of the periodicStartDate property.

Returns:
possible object is String

setPeriodicStartDate

public void setPeriodicStartDate(Calendar value)
Sets the value of the periodicStartDate property.

Parameters:
value - allowed object is String

getModTime

public Calendar getModTime()
Gets the value of the modTime property.

Returns:
possible object is String

setModTime

public void setModTime(Calendar value)
Sets the value of the modTime property.

Parameters:
value - allowed object is String

getRuleCurrentStatus

public AccessRuleCurrentStatusCodeType getRuleCurrentStatus()
Gets the value of the ruleCurrentStatus property.

Returns:
possible object is AccessRuleCurrentStatusCodeType

setRuleCurrentStatus

public void setRuleCurrentStatus(AccessRuleCurrentStatusCodeType value)
Sets the value of the ruleCurrentStatus property.

Parameters:
value - allowed object is AccessRuleCurrentStatusCodeType

getRuleStatus

public AccessRuleStatusCodeType getRuleStatus()
Gets the value of the ruleStatus property.

Returns:
possible object is AccessRuleStatusCodeType

setRuleStatus

public void setRuleStatus(AccessRuleStatusCodeType value)
Sets the value of the ruleStatus property.

Parameters:
value - allowed object is AccessRuleStatusCodeType

getAny

public Object[] getAny()
Returns:
array of Element Object

getAny

public Object getAny(int idx)
Returns:
one of Element Object

getAnyLength

public int getAnyLength()

setAny

public void setAny(Object[] values)
Parameters:
values - allowed objects are Element Object

_getAny

protected List<Object> _getAny()

setAny

public Object setAny(int idx,
                     Object value)
Parameters:
value - allowed object is Element Object

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.