com.ampro.robinhood.endpoint.collection.data

Class InstrumentCollectionList

java.lang.Object

com.ampro.robinhood.endpoint.collection.data.InstrumentCollectionList

All Implemented Interfaces:

ApiElement

public class InstrumentCollectionList
extends java.lang.Object
implements ApiElement

The Class InstrumentCollectionList. Examples of collections include 'manufacturing', 'consumer-product', and '100-most-popular'

Constructor Summary

Constructors

Constructor and Description
InstrumentCollectionList()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCanonical_examples()
java.lang.String	getDescription()
java.util.List<Instrument>	getInstruments() Gets the instrument list.
java.lang.String	getName()
java.lang.String	getSlug()
boolean	requiresAuth()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstrumentCollectionList

public InstrumentCollectionList()

Method Detail

getInstruments

public java.util.List<Instrument> getInstruments()
                                          throws RobinhoodApiException

Gets the instrument list. (Makes API Call)

Returns:

the instrument fundamental list

Throws:

RobinhoodApiException - the robinhood api exception

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getCanonical_examples

public java.lang.String getCanonical_examples()

getSlug

public java.lang.String getSlug()

requiresAuth

public boolean requiresAuth()

Specified by:

requiresAuth in interface ApiElement

Returns:

If the element requires an authorized API (i.e. Is user-specific data)