org.sagebionetworks.bridge.rest.model

Class PostalCodeConstraints

java.lang.Object

org.sagebionetworks.bridge.rest.model.Constraints

org.sagebionetworks.bridge.rest.model.PostalCodeConstraints

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class PostalCodeConstraints
extends Constraints

A data type for capturing partial postal code information. Although postal codes can be useful for locating users, combined with other information (such as gender and birthdate, or a rare disease condition), they can be identifying. For this reason there is guidance to the client on how this data can be collected, while preserving anonymity: * Canada (CA) - The first three characters of a Canadian postal code describe a sorting area of about 7,000 households. No specific guidance is given, but collecting the first 3 characters has been deemed reasonable. * United States (US) - collect only the first three digits of a zip code. Some 3 digit codes describe areas of 20,000 or less people; for these exceptional codes, substitute the value \"000\" instead before submitting to the server. If the survey constraints indicate that a US zip code is required, the `sparseZipCodePrefixes` array will be included in the constraint, with a list of these special partial zip codes. They are provided by the server so they can be updated based on new census information without having to update the survey or the client. One way to protect the anonymity of the user is to limit the combination of partially identifying information that is asked for in a survey. For example do no ask for a specific birthdate in a survey where the information will be submitted to the server. This makes a partial postal code significantly less useful for reidentification. **UI hints:** postalcode.

Constructor Summary

Constructors

Constructor and Description
PostalCodeConstraints()

Method Summary

Modifier and Type	Method and Description
PostalCodeConstraints	countryCode(CountryCode countryCode)
boolean	equals(Object o)
CountryCode	getCountryCode() Get countryCode
List<String>	getSparseZipCodePrefixes() Some 3 digit codes describe areas of 20,000 or less people; for these exceptional codes, which can more easily be used to reidentify participants, substitute the value \"000\" instead before submitting the survey answer to the server.
int	hashCode()
void	setCountryCode(CountryCode countryCode)
String	toString()

Methods inherited from class org.sagebionetworks.bridge.rest.model.Constraints

dataType, getDataType, getType, isRequired, required, setDataType, setRequired

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PostalCodeConstraints

public PostalCodeConstraints()

Method Detail

countryCode

public PostalCodeConstraints countryCode(CountryCode countryCode)

getCountryCode

public CountryCode getCountryCode()

Get countryCode

Returns:

countryCode

setCountryCode

public void setCountryCode(CountryCode countryCode)

getSparseZipCodePrefixes

public List<String> getSparseZipCodePrefixes()

Some 3 digit codes describe areas of 20,000 or less people; for these exceptional codes, which can more easily be used to reidentify participants, substitute the value \"000\" instead before submitting the survey answer to the server. If the survey constraints indicate that a US zip code is required, the `sparseZipCodePrefixes` array will be included in the constraint, with a list of these special partial zip codes.

Returns:

sparseZipCodePrefixes

equals

public boolean equals(Object o)

Overrides:

equals in class Constraints

hashCode

public int hashCode()

Overrides:

hashCode in class Constraints

toString

public String toString()

Overrides:

toString in class Constraints